To allow us to automatically create a good quality changelog from our git history we recommend the following formats for commit messages.
The aim is to capture a reference to any ticket, card, or story that this commit contributes towards.
Because we are now using the Pivotal Tracker Webhook on some projects we suggest wrapping your commit message prefix with square brackets []
http://pivotallabs.com/level-up-your-development-workflow-with-github-pivotal-tracker/
The most important part is to capture the platform and reference number in the summary (~50 chars):
[{Platform} #{Reference ID}] {Commit Message}
{* Further Explantion (wrap at 72 chars)}
{Link to Card}
(* Optional )
Commit messages should be written in the present tense in the third person. i.e. "Fixes a typo" not "Fixed a typo" or "Fixing a typo"
If the work relates to a well defined section of a project then it can be useful to reference that at the beginning of the commit message. This convention is know as the Harrington, see pivotal example below.
- PT - Pivotal tracker
- FD - Freshdesk
- GH - Github
- TR - Trello
[PT #912942] my-perks: first implementation of perk tracking
This tracks:
- downloads
- vouchers
- unique vouchers
https://www.pivotaltracker.com/n/projects/912942
[FD #1714] Hide all but 1st splash image until page load
https://clocklimited.freshdesk.com/helpdesk/tickets/1714
If you want your commit message to be excluded from the changelog our convention is to prefix with a greater than sign '>'
> Fixing linting error
Probably worth mentioning the chevron style commit message: