Commit Conventions Cheat Sheet

Format

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Type

  • feat: Feature
  • fix: Bug fix
  • docs: Documentation changes
  • style: Formatting, no code changes
  • refactor: Neither feature nor bug
  • perf: Performance improvements
  • test: Adding tests (no code change)
  • chore: Maintenance changes (no code change)

Scope

Scope defines the part of the application/library the commit is related to, e.g.: $frontend, $backend, $database, $ui etc.

Subject

  • imperative present tense: add or change, not added/changes
  • lower case, noe capital first letter
  • no line delimiter . (dot)

Body (optional)

  • imperative present tense, as above
  • explanation of changes and motivation
  • contains breaking changes, format : BREAKING CHANGE: <text>
  • Issue/ticket reference (Fixes [<No>]/Closes [<No>])