Skip to content

Commit Message Convention

Jump to bottom
Samuel Afolaranmi edited this page Aug 20, 2019 · 2 revisions

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:

  • feat
  • 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 be:

  • Written in the present tense.
  • Include the reason for change and difference in the previous behavior

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

Start #345564738

In the case of multiple issues:

Finishes #5438233, #5891837, #4988398

For completing chores:

Maintains #5438233

Example

feat (hot-desk): Notify logos ops team on hot-desk request

- listens to HotDest request inserts.
- Notify [email protected] of the request.

[Finishes #163219791]
Clone this wiki locally