@dwp/commitlint-config-base
v4.0.6
Published
base configuration for commitlint
Downloads
6,773
Readme
@dwp/commitlint-config-base
Shareable commitlint
config enforcing our commit convention.
Originally based upon the Conventional Commit Message Guidelines
and derived from @commitlint/config-conventional.
In addition to the above guidelines, it will prevent committing of messages which could skip CI pipelines.
Use with @commitlint/cli and @commitlint/prompt-cli.
Getting started
npm install --save-dev @dwp/commitlint-config-base @commitlint/cli
Rules
Add a commitlint.config.js
file that looks something like:
module.exports = require( '@dwp/commitlint-config-base' );
You can add your own rules to enhance this, but in doing so please ensure you don't weaken the baseline ruleset.
## Linting
Add commitlint
to your test suite like this, or see our package.json for an example of how we do it:
"test": "commitlint --from=develop --to=HEAD"