@hadenlabs/commitlint-config v0.1.0

commitlint-config

Commitlint 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

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"
    }
  }
}

Help

Got a question?

File a GitHub issue, send us an email or join our Slack Community.

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Development

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

1. Fork the repo on GitHub
2. Clone the project to your own machine
3. Commit changes to your own branch
4. Push your work back up to your fork
5. Submit a Pull Request so that we can review your changes

NOTE: Be sure to rebase the latest changes from "upstream" before making a pull request!

Versioning

Releases are managed using github release feature. We use Semantic Versioning for all the releases. Every change made to the code base will be referred to in the release notes (except for cleanups and refactorings).

Copyright

Copyright © 2018-2021 Hadenlabs

Trademarks

All other trademarks referenced herein are the property of their respective owners.

License

The code and styles are licensed under the MIT license See project license..

Don't forget to 🌟 Star 🌟 the repo if you like commitlint-config

Your feedback is appreciated