Skip to content

Commit Message Convention

Jump to bottom
Michael Umanah edited this page Mar 13, 2018 · 1 revision

Format of the commit message

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

Any line cannot be longer than 100 characters, meaning be concise.

Subject line <type> should be:

  • feature
  • bug
  • chore
  • release
  • refactor
  • documentation
  • style
  • test

<scope> should be something specific to the commit change. For example:

costume

  • flight
  • fighting-style
  • fan-base
  • logo and so on.

<subject> text should:

  • use present tense: "save" not "saved" or "saving"
  • not capitalize first letter i.e no "Carry to safety"
  • not end with a dot (.)

Message body (optional) If a body is to be written, it should:

  • written in present tense.
  • include reason for change and difference in the previous behaviour

Message Footer This should be used for referencing the issues using the following keywords: Start, Delivers, Fixes and Finishes. it should be inside a square bracket. Example:

[Start #345]

or in a case of multiple issues:

[Finishes #5438233, #5891837, #4988398]

Example

chore(coveralls):add coveralls yml
[Finishes #153742460]

Clone this wiki locally