mwaterous/semantic-commit-messages.md

Forked from joshbuchea/semantic-commit-messages.md

Last active February 10, 2022 20:50

Star (0) You must be signed in to star a gist
Fork (0) You must be signed in to fork a gist

Select an option

Learn more about clone URLs
Clone this repository at <script src="https://gist.github.com/mwaterous/c9fa784bd95cf9824df19291f6256d70.js"></script>
Save mwaterous/c9fa784bd95cf9824df19291f6256d70 to your computer and use it in GitHub Desktop.

Download ZIP

Semantic Commit Messages

Raw

semantic-commit-messages.md

Semantic Commit Messages

See how a minor change to your commit message style can make you a better programmer.

Format: <type>: <subject>

Example

feat: add hat wobble
^--^  ^------------^
|     |
|     +-> Summary in present tense.
|
+-------> Type: feat, fix, docs, style, refactor, chore, or wip.

More Examples:

feat: (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)
style: (changes to the user interface or user experiance of a feature)
updates: (other updates to a function or component that are neither a new feature or a bug fix)
refactor: (refactoring production code, eg. renaming a variable)
chore: (updating build tasks, content, etc; no production code change)
wip: (work in progress, changes are being committed to preview or otherwise store)

References:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment