Skip to content

Instantly share code, notes, and snippets.

@johnson86tw

johnson86tw/semantic-commit-messages.md

Forked from joshbuchea/semantic-commit-messages.md
Created October 21, 2020 02:41
Show Gist options
  • Save johnson86tw/94efcb371cb775400db20ce6875800ae to your computer and use it in GitHub Desktop.
Save johnson86tw/94efcb371cb775400db20ce6875800ae 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>(<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: (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)

References:

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