-
Notifications
You must be signed in to change notification settings - Fork 0
Commit Message Convention
Vanessa Ejikeme edited this page Feb 19, 2018
·
1 revision
#Format of the commit message
Any line cannot be longer than a 100 characters, meaning be concise. This may require using the
interactive commit message interface using git commit
for longer messages.
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
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 be:
- 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 written as:
[Start #345]
or in a case of multiple issues:
[Finishes #5438233, #5891837, #4988398]