Skip to content

Latest commit

 

History

History
38 lines (27 loc) · 1.02 KB

GIT_COMMIT_SPECIFIC.md

File metadata and controls

38 lines (27 loc) · 1.02 KB

GIT COMMIT MESSAGE CHEAT SHEET

Proposed format of the commit message

<type>(<scope>): <subject>

<body>

All lines are wrapped at 100 characters !

Allowed <type>

  • breaking --- Breaking Change,
  • feat --- A new feature,
  • bugfix --- Bug Fix,
  • doc --- Documentation,
  • refactor --- Some Code Change,
  • test --- Update Test Cases,
  • perf --- Improve Performace,
  • build --- Update Workflow Scripts,
  • chore --- Improve Some Code

Allowed <scope> Scope could be anything specifying place of the commit change.

For example $location, $browser, compiler, scope, ng:href, etc...

Breaking changes All breaking changes have to be mentioned in message body, on separated line: ​ Breaks removed $browser.setUrl() method (use $browser.url(newUrl))Breaks ng: repeat option is no longer supported on selects (use ng:options)

Message body

  • uses the imperative, present tense: “change” not “changed” nor “changes”
  • includes motivation for the change and contrasts with previous behavior