Skip to content

Instantly share code, notes, and snippets.

@savilaf
Forked from joshbuchea/semantic-commit-messages.md
Last active August 22, 2019 13:03
Show Gist options
  • Save savilaf/456e74081959046077a23e5ff76c3e26 to your computer and use it in GitHub Desktop.
Save savilaf/456e74081959046077a23e5ff76c3e26 to your computer and use it in GitHub Desktop.
Semantic Commit Messages

Semantic Commit Messages

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

Format: <type>(<scope>): <subject> (<taskID>)

<scope> is optional

<taskID> is optional; link to JIRA task o GitHub issue

Example

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

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)
  • ci: (add or fix ci tasks)
  • build: (add or fix build tasks)
  • perf: (improve code; not refactor, no fix)

Reference(s):

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