Skip to content

Instantly share code, notes, and snippets.

@lorival

lorival/commit-message-structure.md

Last active March 25, 2018 22:50
Show Gist options
  • Save lorival/5806185b9cb64b6ac77698fdd9c8fd3c to your computer and use it in GitHub Desktop.
Save lorival/5806185b9cb64b6ac77698fdd9c8fd3c to your computer and use it in GitHub Desktop.
Download ZIP
Documentation of the format of commits I like to use
Raw
commit-message-structure.md

My git Commit msg structure based on Angular convention

type(context): subject

type can be:

  • feat (new feature for the user, not a new feature for build script)
  • fix (bug fix for the user, not a fix to a build script)
  • docs (changes to the documentation)
  • refactor (refactoring production code, eg. renaming a variable)
  • test (adding missing tests, refactoring tests; no production code change)
  • chore (updating grunt tasks etc; no production code change)

context can be:

  • enviroment
  • layers: domain, app, infra, alloy
  • notebook
  • integration

subject must:

  • be short and clear
  • always be in present tense: “change” not “changed” nor “changes”
  • includes motivation for the change and contrasts with previous behavior
  • have the first small letter
  • not have dot(.) at the end

REF

http://karma-runner.github.io/2.0/dev/git-commit-msg.html https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment