12345678910111213141516171819202122232425262728293031 |
- The commit contains the following structural elements, to communicate
- intent to the consumers of your library:
- fix: a commit of the type fix patches a bug in your codebase
- (this correlates with PATCH in semantic versioning).
- feat: a commit of the type feat introduces a new feature to the codebase
- (this correlates with MINOR in semantic versioning).
- 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).
- A BREAKING CHANGE can be part of commits of any type.
- Others: commit types other than fix: and feat: are allowed,
- like chore:, docs:, style:, refactor:, perf:, test:, and others.
- We also recommend improvement for commits that improve a current
- implementation without adding a new feature or fixing a bug.
- 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).
- A 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.
- <type>[optional scope]: <description>
- [optional body]
- [optional footer]
|