Skip to content

Instantly share code, notes, and snippets.

@Wayne42
Forked from joshbuchea/semantic-commit-messages.md
Last active April 20, 2023 16:22
Show Gist options
  • Save Wayne42/18e1adfa94c1b1fa255267701fb5de2e to your computer and use it in GitHub Desktop.
Save Wayne42/18e1adfa94c1b1fa255267701fb5de2e 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>

<scope> is optional

Example

feat: add hat wobble
^--^  ^------------^
|     |
|     +-> Summary in imperative language.
|
+-------> 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)

References:

Commit-Messages sind schwer und nervig, aber wichtig für Codereviews. Einfach Mühe geben, es wird mit der Zeit einfacher.

Änderungen gut Portionieren in einzelne Commits.

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