@hdnet/commitlint-config
v1.0.0
Published
HDNET commitlint-config, implementing HSR-3
Downloads
529
Readme
HDNET commitlint-config
This packages defines the strict implementation of the HDNET Commit Message Guidelines from the HDNET Standard Recommendations (HSR-3) as npm package using commitlint through a shareable config.
Getting started
Ideally, setup Node.js >= 20.
Install dependencies
$ npm i -D @commitlint/cli @hdnet/commitlint-config
For Node.js < 18:
$ npm i -D @commitlint/cli@17 @hdnet/commitlint-config@0
For Node.js < 20:
$ npm i -D @commitlint/cli@18 @hdnet/commitlint-config@0
- Create commitlint config (i.e.
commitlint.config.mjs
) and extend from @hdnet/commitlint-config:
export default {
extends: '@hdnet',
parserPreset: {
parserOpts: {
// replace "PROJECT-" with your issue prefix
issuePrefixes: ['PROJECT-'],
},
},
}
- Add commitlint to you git hook configuration (i.e. using husky)
Contribute
To setup current node version, you can use nvm (in this project a .nvmrc file is maintained).