Commit Type | Title | Description | Emoji |
---|---|---|---|
feat | Features | A new feature | ⨠|
fix | Bug Fixes | A bug Fix | đ |
docs | Documentation | Documentation only changes | đ |
style | Styles | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) | đ |
refactor | Code Refactoring | A code change that neither fixes a bug nor adds a feature | đŚ |
perf | Performance Improvements | A code change that improves performance | đ |
test | Tests | Adding missing tests or correcting existing tests | đ¨ |
build | Builds | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) | đ |
ci | Continuous Integrations | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) | âď¸ |
chore | Chores | Other changes that don't modify src or test files | âťď¸ |
revert | Reverts | Reverts a previous commit | đ |
Specification â
The key words âMUSTâ, âMUST NOTâ, âREQUIREDâ, âSHALLâ, âSHALL NOTâ, âSHOULDâ, âSHOULD NOTâ, âRECOMMENDEDâ, âMAYâ, and âOPTIONALâ in this document are to be interpreted as described in RFC 2119.
- Commits MUST be prefixed with a type, which consists of a noun,Â
feat
,Âfix
, etc., followed by the OPTIONAL scope, OPTIONALÂ!
, and REQUIRED terminal colon and space. - The typeÂ
feat
 MUST be used when a commit adds a new feature to your application or library. - The typeÂ
fix
 MUST be used when a commit represents a bug fix for your application. - A scope MAY be provided after a type. A scope MUST consist of a noun describing a section of the code base surrounded by parenthesis, e.g.,Â
fix(parser):
- A description MUST immediately follow the colon and space after the type/scope prefix. The description is a short summary of the code changes, e.g., fix: array parsing issue when multiple spaces were contained in string.
- A longer commit body MAY be provided after the short description, providing additional contextual information about the code changes. The body MUST begin one blank line after the description.
- A commit body is free-form and MAY consist of any number of newline separated paragraphs.
- One or more footers MAY be provided one blank line after the body. Each footer MUST consist of a word token, followed by either aÂ
:<space>
 orÂ<space>#
 separator, followed by a string value (this is inspired by the git trailer convention). - A footerâs token MUST useÂ
-
 in place of white space characters, e.g.,ÂAcked-by
 (this helps differentiate the footer section from a multi-paragraph body). An exception is made forÂBREAKING CHANGE
, which MAY also be used as a token. - A footerâs value MAY contain spaces and newlines, and parsing MUST terminate when the next valid footer token/separator pair is observed.
- Breaking changes MUST be indicated in the type/scope prefix of a commit, or as an entry in the footer.
- If included as a footer, a breaking change MUST consist of the uppercase text BREAKING CHANGE, followed by a colon, space, and description, e.g., BREAKING CHANGE: environment variables now take precedence over config files.
- If included in the type/scope prefix, breaking changes MUST be indicated by aÂ
!
 immediately before theÂ:
. IfÂ!
 is used,ÂBREAKING CHANGE:
 MAY be omitted from the footer section, and the commit description SHALL be used to describe the breaking change. - Types other thanÂ
feat
 andÂfix
 MAY be used in your commit messages, e.g., docs: update ref docs. - The units of information that make up Conventional Commits MUST NOT be treated as case sensitive by implementors, with the exception of BREAKING CHANGE which MUST be uppercase.
- BREAKING-CHANGE MUST be synonymous with BREAKING CHANGE, when used as a token in a footer.