When contributing to this repository, please first discuss the change you wish to make via issue before making a change.
This NPM package is published by semantic-release. In order to make it work you need to follow conventional commit format when writing your commit messages. To make this process easier you can use interactive CLI tool commitizen.
Install commitizen:
npm install -g commitizen
Commit your changes with commitizen. Instead of running git commit start commitizen:
cz
semantic-release uses the commit messages to determine the consumer impact of changes in the codebase. Following formalized conventions for commit messages, semantic-release automatically determines the next semantic version number, generates a changelog and publishes the release.
By default, semantic-release uses Angular Commit Message Conventions. The commit message format can be changed with the preset or config options of the @semantic-release/commit-analyzer and @semantic-release/release-notes-generator plugins.
The table below shows which commit message gets you which release type when semantic-release runs (using the default configuration):
| Commit message | Release type |
|---|---|
| fix(pencil): stop graphite breaking when too much pressure applied | |
| feat(pencil): add 'graphiteWidth' option | |
| perf(pencil): remove graphiteWidth option BREAKING CHANGE: The graphiteWidth option has been removed |
|
| chore(pencil): don't bother publishing | Release not triggered |