GitHub Workflow

Jump to bottom

Daniel Lasry edited this page Jan 20, 2019 · 3 revisions

First, download and install git for your platform. When ready, return here.

1. Fork This Repo

How to fork a repo

How to keep your fork in sync

2. Branch off of development

> git checkout development

3. Create your feature branch

> git checkout -b my-new-feature

Git feature branch workflow

You are now ready to make changes.

4. Commit your changes

> git commit -m 'Add some feature'

Git commit message prefixes

[RFR] - Code refectoring
[WIP] - Work in progress
[FIX] - Bug fix
[FTR] - New feature
[SCR] - Security issue fix
[CLP] - Changes that do not alter functionality, but improve code style and readability.
[CRO] - Content Rate Optimization
[TST] - Add test suite for slider component
[!!!] - Deprecated. Can only be used with [FTR]

5. Push to the branch

> git push origin my-new-feature

6. Submit a pull request.

Make sure it is based off of the development branch when submitting! :D

Please feel free to contribute tips, tricks and best practices.