Skip to content

Instantly share code, notes, and snippets.

@heymage

heymage/semantic-commit-messages.md

Forked from joshbuchea/semantic-commit-messages.md
Last active November 18, 2021 15:38
Show Gist options
  • Save heymage/b10facd1e54d891cc618b2511dbe0df7 to your computer and use it in GitHub Desktop.
Save heymage/b10facd1e54d891cc618b2511dbe0df7 to your computer and use it in GitHub Desktop.
Download ZIP
Semantic Commit Messages
Raw
semantic-commit-messages.md

Semantic Commit Messages

Syntax: <type>: <summary>

Example

feat: add awesome feature
^--^  ^-----------------^
|     |
|     +-> Summary in present tense. No dot (.) at the end
|
+-------> Type: feat, fix, ref, docs, style, or test.

More Examples:

  • feat: (new feature for the user, not a new feature for build scripts)
  • fix: (bug fix for the user, not a fix to a build script)
  • ref: (refactoring production code, eg. renaming a variable)
  • docs: (changes to the documentation)
  • style: (formatting, missing semi colons, etc; no production code change)
  • test: (adding missing tests, refactoring tests; no production code change)
  • chore: (updating build scripts etc; no production code change)

References:

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