Skip to main content

Commit / Merge Request Message

Mix and match of the best git commit messaging standards.

  1. The summary line will be written in the imperative form
    • 'fix bug' not 'fixed bug'
    • 'add feature' not 'added feature'
  2. Ideally the summary line should be 50 chars or less
  3. All subsequent lines in the commit message are 72 characters or less
  4. First line of the commit is a brief summary
  5. The body will contain a more detailed explanation of the change. A blank line MUST seperate the summary from the body
  6. If a commit introduces a breaking change then the body will be prefaced by BREAKING CHANGE:
    • Can be used with ANY type of commit
  7. The JIRA ticket id will be added as a new line with prefix ticket_id
  8. The summary will take the following form:-

Format

<type> (scope) (!) : <description>

type = ['fix','feat','chore','style','refactor','improvement']
scope = what part of the codebase was changed

Feature

feat(raphafacades): add single purchase of product

BREAKING CHANGE: Add new `singlePurchaseProduct` field, add new solr
index and ensure product can only be purchased once.

ticket_id: RAPHACC-007