Skip to content
Zenuncl Wiki

Git Commit Style

<TYPE>(<Scope>): <Subject>


<Body>


<Footer>

Notes:

Section titled “Notes:”
  • A commit that introduce breaking changes must be indicated by an ! before the : after scope. e.g. feat(api)!: remove status endpoint
  • No dot (.) at the end, and use the imperative, present tense: “change” instead of “changed” nor “changes”.
  • A good suggestion is “don’t capitalize the first letter”, but I normally will CAP the type.

Type:

Section titled “Type:”
  • Update:
    • BREAK: Breaking change, Major version (x.0.0) update
    • FEAT: New Feature (Monor versioon 0.x.0 update)
    • FIX: Fix bugs (for patch number 0.0.x)
  • Other:
    • DOCS: Change to the documentation (README, CHANGELOG, CONTRIBUTE, API docs, etc.)
    • STYLE / FORMAT: Code formatting, code comment change, etc; (compiled-code neutral)
    • REFACTOR: Code refactoring
      • PERF: Performance improvement
    • OPS: Operational aspects like infrastructure, deployment scripts, etc.
      • BUILD: Changes that affect the build system or external dependencies.
      • TEST: Add or editing test.
      • CI: Changes to CI / CD configuration or scripts.
    • MAINT: Updating dev-related maintenance files (“non-production code” files)
    • CHORE: Change dependency, tools or building process. (Similar to MAINT)
    • REVERT: Revert to pervious version
    • MERGE: Merge a branch, and follows default git merge message.

Scope (Option):

Section titled “Scope (Option):”
  • Project division
  • Packages or Modules
  • e.g. common, core, server, upgrade, changelog, and darwin

Subject:

Section titled “Subject:”
  • This is a Summary of the change. (Should be brief)

Body:

Section titled “Body:”
  • This is a details about the change.
Section titled “Footer:”
  • Issue #
  • Comment
  • BREAKING CHANGE: if there is any

Reference: