@sngular/commitlint-config

Sharable commitlint config enforcing SNGULAR style guidelines. Uses:

• @commitlint/config-conventional: Shareable commitlint config enforcing conventional commits.

Getting started

npm install --save-dev @sngular/commitlint-config
echo "module.exports = { extends: ['@sngular'] };" > commitlint.config.cjs

After that you can use husky to add a commit-msg hook to lint your commit messages:

npx husky add .husky/commit-msg 'npx --no -- commitlint --edit "$1"'

To help adoption you can use @commitlint/prompt-cli to write commit messages faster and ensures they adhere to the commit convention.

npm install --save-dev @commitlint/{cli,prompt-cli}

Rules

We are following the following recommendations @commitlint/config-conventional

body-max-line-length

We decide to remove this limit to allow add release notes in the commit body.