domharrington/commit-style-guide.md

## commit-style-guide.md

      
    Raw
  

              commit-style-guide.md
            
          
    Clock Committing Style Guide

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.
The most important part is to capture the platform and reference number:
{Platform} #{Reference ID} {Commit Message}

{* Further Information}

{Link to Card}


(* Optional )
Commit Message

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.
Platform Prefixes


PT - Pivotal tracker
FD - Freshdesk

Examples

Pivotal tracker

PT #912942 my-perks: first implementation of perk tracking

This tracks:
- downloads
- vouchers
- unique vouchers

https://www.pivotaltracker.com/n/projects/912942

Fresh Desk

FD #1714 Hide all but 1st splash image until page load

https://clocklimited.freshdesk.com/helpdesk/tickets/1714