semantic-commit-messages.md

Semantic Commit Messages

See how a minor change to your commit message style can help everyone.

Format: <type>[<scope>](issue #): <short summary>

<scope> is optional

<issue #> is optional

Example

       /‾‾‾‾‾‾‾‾
  😼  <  Meow! Please use semantic commit messages
       \________

  <type>[<scope>](issue #): <short summary>
     │      │        |             │
     |      |        |             └─> Summary in present tense. Not capitalized. No period at the end. 
     |      |        |  
     │      │        └─> Issue # (optional): Issue number if related to bug database.           
     │      │
     │      └─> Scope (optional): eg. common, compiler, authentication, core
     │                                                                                          
     └─> Type: chore, docs, feat, fix, refactor, style, or test.

More Examples:

• 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)
• style: (formatting, missing semi colons, etc; no production code change)
• 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)

References:

• https://www.conventionalcommits.org/
• https://seesparkbox.com/foundry/semantic_commit_messages
• http://karma-runner.github.io/1.0/dev/git-commit-msg.html