@dwp/commitlint-config-base

base configuration for commitlint

Stats

StarsIssuesVersionUpdatedCreatedSize
@dwp/commitlint-config-base
241.2.06 months ago4 years agoMinified + gzip package size for @dwp/commitlint-config-base in KB

Readme

@dwp/commitlint-config-base

Shareable commitlint config enforcing our commit convention. Originally based upon the AngularJS Commit Message Guidelines and derived from @commitlint/config-angular. 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"

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.