Skip to content

Instantly share code, notes, and snippets.

@jacsamg

jacsamg/semantic-commit-messages.md

Forked from joshbuchea/semantic-commit-messages.md
Last active November 7, 2018 05:20
Show Gist options
  • Save jacsamg/24207c5d5b3c4085b3a0f5c46f161f1c to your computer and use it in GitHub Desktop.
Save jacsamg/24207c5d5b3c4085b3a0f5c46f161f1c 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: feat, improvement, fix, refactor, style, chore, test, or docs.

More Examples:

  • feat: new feature for production
  • improvement: production improvements without adding new features or correcting errors
  • fix: bug fix for production
  • refactor: refactoring production code, eg. renaming a variable
  • style: formatting, missing semi colons, etc.
  • chore: routine tasks related to the environment, libraries, scripts, etc.; no production code change
  • test: adding missing tests, refactoring tests; no production code change
  • docs: changes to the documentation; no production code change

Reference(s):

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