cz_customize_info.txt 1.3 KB

12345678910111213141516171819202122232425262728293031
  1. The commit contains the following structural elements, to communicate
  2. intent to the consumers of your library:
  3. fix: a commit of the type fix patches a bug in your codebase
  4. (this correlates with PATCH in semantic versioning).
  5. feat: a commit of the type feat introduces a new feature to the codebase
  6. (this correlates with MINOR in semantic versioning).
  7. BREAKING CHANGE: a commit that has the text BREAKING CHANGE: at the beginning of
  8. its optional body or footer section introduces a breaking API change
  9. (correlating with MAJOR in semantic versioning).
  10. A BREAKING CHANGE can be part of commits of any type.
  11. Others: commit types other than fix: and feat: are allowed,
  12. like chore:, docs:, style:, refactor:, perf:, test:, and others.
  13. We also recommend improvement for commits that improve a current
  14. implementation without adding a new feature or fixing a bug.
  15. Notice these types are not mandated by the conventional commits specification,
  16. and have no implicit effect in semantic versioning (unless they include a BREAKING CHANGE).
  17. A scope may be provided to a commit’s type, to provide additional contextual
  18. information and is contained within parenthesis, e.g., feat(parser): add ability to parse arrays.
  19. <type>[optional scope]: <description>
  20. [optional body]
  21. [optional footer]