Types other than feat and fix MAY be used in your commit messages, e.g., docs: update ref docs.If ! is used, BREAKING CHANGE: MAY be omitted from the footer section,Īnd the commit description SHALL be used to describe the breaking change. If included in the type/scope prefix, breaking changes MUST be indicated by a.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.,īREAKING CHANGE: environment variables now take precedence over config files.Breaking changes MUST be indicated in the type/scope prefix of a commit, or as an entry in the.A footer’s value MAY contain spaces and newlines, and parsing MUST terminate when the next valid footer.An exception is made for BREAKING CHANGE, which MAY also be used as a token. The footer section from a multi-paragraph body). A footer’s token MUST use - in place of whitespace characters, e.g., Acked-by (this helps differentiate.Each footer MUST consist ofĪ word token, followed by either a : or # separator, followed by a string value (this is inspired by the One or more footers MAY be provided one blank line after the body.A commit body is free-form and MAY consist of any number of newline separated paragraphs.

The body MUST begin one blank line after the description. A longer commit body MAY be provided after the short description, providing additional contextual information about the code changes.The description is a short summary of the code changes, e.g., fix: array parsing issue when multiple spaces were contained in string. A description MUST immediately follow the colon and space after the type/scope prefix.Section of the codebase surrounded by parenthesis, e.g., fix(parser): A scope MUST consist of a noun describing a The type fix MUST be used when a commit represents a bug fix for your application.The type feat MUST be used when a commit adds a new feature to your application or library.Commits MUST be prefixed with a type, which consists of a noun, feat, fix, etc., followedīy the OPTIONAL scope, OPTIONAL !, and REQUIRED terminal colon and space.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. Remove timeouts which were used to mitigate the racing issue but are Incoming responses other than from latest request. Introduce a request id and a reference to latest request. Examples Commit message with description and breaking change footer feat: allow provided config object to extend other configsīREAKING CHANGE: `extends` key in config file is now used for extending other config filesĬommit message with ! to draw attention to breaking change feat!: send an email to the customer when a product is shippedĬommit message with scope and ! to draw attention to breaking change feat(api)!: send an email to the customer when a product is shippedĬommit message with both ! and BREAKING CHANGE footer chore!: drop support for Node 6īREAKING CHANGE: use JavaScript features not available in Node 6.Ĭommit message with no body docs: correct spelling of CHANGELOGĬommit message with scope feat(lang): add Polish languageĬommit message with multi-paragraph body and multiple footers fix: prevent racing of requests footers other than BREAKING CHANGE: may be provided and follow a convention similar toĪdditional types are not mandated by the Conventional Commits specification, and have no implicit effect in Semantic Versioning (unless they include a BREAKING CHANGE).Ī scope may be provided to a commit’s type, to provide additional contextual information and is contained within parenthesis, e.g., feat(parser): add ability to parse arrays.types other than fix: and feat: are allowed, for example (based on the Angular convention) recommends build:, chore:,Ĭi:, docs:, style:, refactor:, perf:, test:, and others.BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning).Ī BREAKING CHANGE can be part of commits of any type.feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).The commit contains the following structural elements, to communicate intent to the The commit message should be structured as follows: Which makes it easier to write automated tools on top of.īy describing the features, fixes, and breaking changes made in commit messages. It provides an easy set of rules for creating an explicit commit history

The Conventional Commits specification is a lightweight convention on top of commit messages. Quick Summary Full Specification Contribute Conventional Commits 1.0.0 Summary

Revert commit