@hadenlabs/commitlint-config NPM

commitlint-config

commitlint-config for project

Requirements

This is a list of plugins that need to be installed previously to enjoy all the goodies of this configuration:

Installation

yarn

If you're using yarn

  yarn add --dev husky @commitlint/cli @commitlint/config-conventional @hadenlabs/commitlint-config

npm

If you're using npm

  npm i --save-dev husky @commitlint/cli @commitlint/config-conventional @hadenlabs/commitlint-config

Usage

How to use this project

Create file .commitlintrc.json with extending preset and define set of scopes:

{
  "extends": ["@hadenlabs/config-conventional"],
  "rules": {
    "type-enum": [
      2,
      "always",
      [
        // as examples
        "app",
        "common"
      ]
    ]
  }
}

Add to package.json next section:

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

Examples

Common

Help

Got a question?

File a GitHub issue.

Contributing

See Contributing.

Module Versioning

This Module follows the principles of Semantic Versioning (SemVer).

Using the given version number of MAJOR.MINOR.PATCH, we apply the following constructs:

Use the MAJOR version for incompatible changes.
Use the MINOR version when adding functionality in a backwards compatible manner.
Use the PATCH version when introducing backwards compatible bug fixes.

Backwards compatibility in `0.0.z` and `0.y.z` version

In the context of initial development, backwards compatibility in versions 0.0.z is not guaranteed when z is increased. (Initial development)
In the context of pre-release, backwards compatibility in versions 0.y.z is not guaranteed when y is increased. (Pre-release)