Skip to content

Instantly share code, notes, and snippets.

Show Gist options
  • Save tienit150198/73d7f76c89eb16679248848f0b263cbb to your computer and use it in GitHub Desktop.
Save tienit150198/73d7f76c89eb16679248848f0b263cbb 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 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
  • [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

Extras:

  • [perf]: production improvements without adding new features or correcting errors
  • [fix]: bug fix for the user, not a fix to a build script
  • [revert]: Change back to the previous commit
  • [license]: Edits regarding licensing, no production code change
  • [conf]: Add or change config project, include: environment, CI/CD, lint,...
  • [deploy]: deployment commit details if using github actions

References:

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