Skip to content

Instantly share code, notes, and snippets.

@djego

djego/commit-convention.md

Last active May 22, 2019 15:11
Show Gist options
  • Save djego/16011316ef7a21d3f69d4ba9d5aaba1e to your computer and use it in GitHub Desktop.
Save djego/16011316ef7a21d3f69d4ba9d5aaba1e to your computer and use it in GitHub Desktop.
Download ZIP
Commit message convention (Cafetech)
Raw
commit-convention.md

Commits conventions

Format of the commit message

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Message header

The message header is a single line that contains succinct description of the change containing a type, an optional scope and a subject. Allowed This describes the kind of change that this commit is providing.

  • feat (feature)
  • fix (bug fix)
  • docs (documentation)
  • style (formatting, missing semi colons, …)
  • refactor
  • test (when adding missing tests)
  • chore (maintain)

Allowed

Scope can be anything specifying place of the commit change. For example location, browser, compile, user, dashboard, login, etc.

QR

More info

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