cz-changelog
A commitizen adapter to standardize commit messages.
Setup
Install commitizen.
npm install -g commitizen
Next, initialize your project to use the cz-changelog adapter.
commitizen init cz-changelog --save-dev
Usage
git cz
Examples
feat: add 'graphiteWidth' option
fix: stop graphite breaking when width < 0.1
perf: remove graphiteWidth option
BREAKING CHANGE: The graphiteWidth option has been removed. The default graphite width of 10mm is always used for performance reason.
Closes https://github.com/angular/angular/issues/3826
Commit Message Format
- A commit message consists of a header, body and footer.
- The header has a type and a subject:
{{type}}: {{subject}}
<BLANK LINE>
{{body}}
<BLANK LINE>
{{breaking changes}}
<BLANK LINE>
{{footer}}
The header is mandatory and the scope of the header is optional.
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.
Type
Must be one of the following:
feat: A new feature.fix: A bug fix.content: A static content change.docs: Documentation only changes.style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc).refactor: A code change that neither fixes a bug, nor adds a feature.perf: A code change that improves performance.test: Adding or modifying tests.chore: Changes to the build process or auxiliary tools and libraries.
Subject
The subject contains succinct description of the change:
- Use the imperative, present tense: "change" not "changed" nor "changes"
- Don't capitalize the first letter
- No dot
.at the end.
Body
Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
Breaking Changes
Breaking Changes should start with the word BREAKING CHANGE: with a space or two newlines.
Footer
The footer is the place to reference any tasks that this commit Closes.
MIT License