Skip to content

Instantly share code, notes, and snippets.

@xpepper

xpepper/semantic-commit-messages.md

Forked from joshbuchea/semantic-commit-messages.md
Last active March 22, 2022 16:55
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save xpepper/9d0aa4ea9f07dae5d352e3e700c8091e to your computer and use it in GitHub Desktop.
Save xpepper/9d0aa4ea9f07dae5d352e3e700c8091e 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, and may contain IDs of the task / user story we are changing the code for (e.g. SELL-123)

Example

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

Available commit types

  • feat: any behavioural change, that will eventually take the form of a new feature / change in an existing feature
  • refactor: refactoring production code: those are all structural changes that preserve the actual behaviour
  • fix: bug fix for the user (even if not already deployed in production, e.g. impacting the stage env), not a fix to a build script
  • docs: changes to the documentation
  • style: formatting, missing semicolons, etc; no changes to production code
  • test: adding missing tests, refactoring only tests; no changes to production code
  • build: changes to the build scripts, updating / upgrading dependencies (e.g. in build.gradle file)
  • chore: updating scripts; no changes to production code
  • ci: changes to the CI scripts

References:

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