Skip to content

Instantly share code, notes, and snippets.

@wojtasemzi

wojtasemzi/semantic-commit-messages.md

Forked from joshbuchea/semantic-commit-messages.md
Last active February 20, 2025 09:54
Show Gist options
  • Save wojtasemzi/318462acf8051053a6e0852f9eb314dc to your computer and use it in GitHub Desktop.
Save wojtasemzi/318462acf8051053a6e0852f9eb314dc 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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment