Skip to content

Commit Message Convention

Jump to bottom
Benny edited this page Dec 17, 2017 · 6 revisions

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

Any line cannot be longer than a 100 characters.

Subject line <type> should be:

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

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

text should: use present tense: "save" not "saved" or "saving" not end with a dot (.)

Message body (optional) If a body is to be written, it should be written in the present tense.

Message Footer This should be used for referencing the issues using the following keywords: Start, Delivers, Fixes and Finishes. It should be written as shown in the example below:

Start #345 or in a case of multiple issues:

Finishes #5438233, #5891837, #4988398

Clone this wiki locally