Semantic Branches

Enjoy this cheat sheet at its fullest within Dash, the macOS documentation browser.

See how a minor change to your branch name style can make you a better programmer.

Format

Format

<type>/*
<type>/<task_description>
<type>/<issue_number>/<task_description>

Example

Example

feat/#1-init
^--^ ^-----^
|     |
|     +-> Summary in present tense.
|
+-------> Type: chore, docs, feat, fix, refactor, style, or test.

More Examples

feat or feature

New feature for the user, not a new feature for build script

fix

Bug fix for the user, not a fix to a build script

docs

Changes to the documentation

style

Formatting, missing semi colons, etc; no production code change

refactor

Refactoring production code, eg. renaming a variable

test

Adding missing tests, refactoring tests; no production code change

chore

Updating grunt tasks etc; no production code change