Semantic Commit Messages

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>(<scope>): <subject>

<scope> is optional

Example

ADD add hat wobble
^-^ ^------------^
|    |
|    +-> Summary in present tense.
|
+-------> Type: some off below

• ADD: (new feature for the user, not a new feature for build script)
• BLD: (build/CI script updates)
• FOC: (bug fix for the user, not a fix to a build script)
• DOC: (changes to the documentation)
• REF: (refactoring production code, eg. renaming a variable)
• TEST: (adding missing tests, refactoring tests; no production code change)
• STYLE: (formatting, missing semi colons, etc; no production code change)
• CHORE: (updating grunt tasks etc; no production code change)

References:

• https://www.conventionalcommits.org/
• https://seesparkbox.com/foundry/semantic_commit_messages
• http://karma-runner.github.io/1.0/dev/git-commit-msg.html