commits.md

May 31, 2016 ยท View on GitHub

Commit Style

Each commit will be created by three parts:

  • type
  • scope
  • subject

The scheme is:

Field of commitIs looking
Title<type>(<scope>)
Description<subject>

You should always use these of types for commits:

TypeDescription
featA new feature.
fixA bug fix.
docsDocumentation only changes.
styleChanges that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc).
refactorA code change that neither fixes a bug or adds a feature.
testAdding missing tests.
choreChanges to the build process or auxiliary tools and libraries such as documentation generation.

The scope is specifying the place of the commit.

For the subject there are these rules:

  • Use the imperative, present tense: "change" not "changed" nor "changes".
  • Do not capitalize first letter.
  • No dot (.) at the end.

Credit to: somus