Skip to content

Instantly share code, notes, and snippets.

@jasenmichael
Last active February 11, 2022 02:39
Show Gist options
  • Save jasenmichael/d98f81063f8315368b897349e785f552 to your computer and use it in GitHub Desktop.
Save jasenmichael/d98f81063f8315368b897349e785f552 to your computer and use it in GitHub Desktop.
Simple Git Commit Message Format

Commit Message Format

Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:

git commit -m "<type>: <subject>"

The header is mandatory and the scope of the header is optional.

Example — git commit -m "fix: remove unused dependency lodash.camelcase"

Any line of the commit message cannot be longer 100 characters. This allows the message to be easier to read on GitHub as well as in various git tools.

Type

Must be one of the following:

  • feat: A new feature.
  • fix: A bug fix.
  • docs: Documentation only changes.
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc).
  • refactor: A code change that neither fixes a bug nor adds a feature.
  • perf: A code change that improves performance.
  • test: Adding missing tests.
  • chore: Changes to the build process or auxiliary tools and libraries such as documentation generation.

Subject

The subject contains succinct description of the change:

  • use the imperative, present tense: change not changed nor changes,
  • don't capitalize first letter,
  • no dot (.) at the end.

A detailed explanation can be found in this document.

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