Skip to content
This repository has been archived by the owner on Apr 19, 2022. It is now read-only.

Git Commit Message Conventions

Jump to bottom
Daniel Pacak edited this page Mar 12, 2016 · 1 revision

Format of the commit message

A commit message consists of a header, a body and a footer, separated by a blank line.

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

Message header

The message header is a single line that contains succinct description of the change containing a type, an optional scope and a subject.

<type>

Type describes the kind of change that this commit is providing.

  • feat (feature)
  • fix (bug fix)
  • docs (documentation)
  • style (formatting, missing semi colons, etc...)
  • refactor
  • test (when adding missing tests)
  • chore (maintain)

<scope>

Scope can be anything specifying place of the commit change. For example dirWalker, api, etc...

<subject>

This is a very short description of the change.

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