Usage no npm install needed!

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

README

`commitlint-config`

Arbetsmyra's commitlint config

Installation

Requirements

node >= v10
npm >= v5
@commitlint/cli >= 9.1

npm install --save-dev @commitlint/cli @arbetsmyra/commitlint-config

Usage

Once the @arbetsmyra/commitlint-config package is installed, you can use it by specifying the @arbetsmyra config for the extends property in the commitlint configuration.

commitlint.config.js:

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

package.json:

{
  "commitlint": {
    "extends": ["@arbetsmyra"]
  }
}

Running commitlint with husky

Install husky:

npm install --save-dev husky

Update package.json with:

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

Contributing

If you want to contribute and make our project better, your help is very welcome.