Conventional Commits

We have created a simple specification to creates commit messages based on other specifications from popular tech companies.

Description

Each commit message includes a type, a subject and a body.

Types

• feat: A new feature

• fix: A bug fix

• docs: Documentation only changes

• style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)

• refactor: A code change that neither fixes a bug nor adds a feature

• perf: A code change that improves performance

• test: Adding missing or correcting existing tests

• chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

Subject

The subject is a limited description of the commit. The limit should not increase the 80 characters.

Body

The body is an extended description of the commit.

• Use the imperative, present tense: "change" not "changed" nor "changes"

• Don't capitalize first letter

• No dot (.) at the end

Example

git commit -m "feat: create user model" -m "extend description..."
               ^--^  ^----------------^     |
               |     |                      |
               |     |                      +-> The body is an extended description of the commit. 
               |     +-> The subject is a summary in present tense.
               |
               +-------> Type: chore, docs, feat, fix, refactor, style, or test.