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 test.

More Examples:

• feat - A new feature for the user, not a new feature for the build script
• fix - A bug fix for the user, not a fix to a build script
• docs - Changes to the documentation
• style - Code formatting, white-space, missing semi-colons, etc; no production code change
• refactor - A code change that neither fixes a bug nor adds a feature, eg. renaming a variable
• test - Adding missing tests or correcting existing tests
• chore - Other changes that don't modify src or test files

Extras:

• perf - A code change that improves performance or optimizes
• build - Changes that affect the build system or external dependencies, eg. gulp, broccoli, npm
• ci - Changes to our CI configuration files and scripts, eg. Travis, Circle, BrowserStack, SauceLabs
• revert - Change back to the previous commit
• license - Edits regarding licensing, 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