Usage no npm install needed!

<script type="module">
  import thingboundCommitlintConfig from 'https://cdn.skypack.dev/@thingbound/commitlint-config';
</script>

README

@thingbound/commitlint-config

Configuration for Commitlint for projects in the @thingbound organization.

Follows Conventional Commits more or less exactly.

When using this config all commits will be on the form:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

This config is used together with Commitlint as a Husky hook.

Install as dev dependencies:

$ npm install --save-dev @commitlint/cli husky @thingbound/commitlint-config

Create a file named commitlint.config.js and define that it to extend this configuration:

module.exports = {
  extends: [
    '@thingbound'
  ]
};

Then in package.json enable commitlint via Husky:

{
  ...,
  "husky": {
    "hooks": {
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
  }
}