A footer of one or more lines MAY be provided one blank line after the body.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 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 an OPTIONAL scope, and a 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. See the issue for details on the typos fixed Examples Commit message with description and breaking change in body 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 optional ! to draw attention to breaking change chore!: drop Node 6 from testing matrixīREAKING CHANGE: dropping Node 6 which hits end of life in AprilĬommit message with no body docs: correct spelling of CHANGELOGĬommit message with scope feat(lang): add polish languageĬommit message for a fix using an (optional) issue number. Notice these 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. We also recommend improvement for commits that improve a current implementation without adding a new feature or fixing a bug. Others: commit types other than fix: and feat: are allowed, for example (based on the Angular convention) recommends chore:, docs:, style:, refactor:, perf:, test:, and others.BREAKING CHANGE: a commit that has the text BREAKING CHANGE: at the beginning of its optional body or footer section 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-beta.4 Summary
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |