Extended 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

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

Or, with the scope:

feat(main page): add hat wobble
^--^ ^--------^  ^------------^
|    |           |
|    +-> Scope (optional)
|                |
|                +-> Summary in present tense.
|
+-------> Type: chore, docs, feat, fix, refactor, style [...]

Prefixes

• bump: (version update)
• chore: (updating grunt tasks etc; no production code change)
• ci: (changes to the build config)
• docs: (changes to the documentation)
• 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)
• localize: (translations update)
• perf: (performance improvements)
• refactor: (refactoring production code, eg. renaming a variable)
• style: (formatting, missing semi colons, etc; no production code change)
• test: (adding missing tests, refactoring tests; 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
• https://gist.github.com/dariusz-wozniak/9c2fafa6487a09aee6474268fcd805f5
• https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716