Skip to content

Instantly share code, notes, and snippets.

@OblateSpheroid

OblateSpheroid/semantic-commit-messages.md

Forked from joshbuchea/semantic-commit-messages.md
Last active September 30, 2021 09:43
Show Gist options
  • Save OblateSpheroid/d2bb2971052e0068e0367d388071e661 to your computer and use it in GitHub Desktop.
Save OblateSpheroid/d2bb2971052e0068e0367d388071e661 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>

<body>

<footer>

<scope> is optional

Header (first line)

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

<type> values:

  • 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

Message body (second line)

  • Use imperative, present tense
  • Includes motivation for the change and contrasts with previous behavior

Footer (third line)

  • Reference issues, as in Closes #123
  • Mention if change is breaking, as in BREAKING CHANGE: <more information>

Reference(s):

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