commitlint-plugin-shr-jira
A plugin that implement all jira commits messages style rules and validate commit messages. Part of commitlint-plugin monorepo.
For Tips and [Advanced Usage](https://javascript.plainenglish.io/how-to-write-correct-jira-commit-messages-d9910f332273) you can read this [Blog Post](https://javascript.plainenglish.io/how-to-write-correct-jira-commit-messages-d9910f332273)
## Getting started.
##### Install dependencies
```bash
npm install --save-dev @commitlint/cli commitlint-config-jira-jquery commitlint-plugin-shr-jira
```
- [commitlint-config-jira-jquery](https://github.com/MinhTrung2031997/commitlint-plugin/tree/master/packages/commitlint-config-jira) - is a **recomended** config who contain preconfigured rules for jira commits messages style. See all rules in description below
- [commitlint-plugin-shr-jira](https://github.com/MinhTrung2031997/commitlint-plugin/tree/master/packages/commitlint-plugin-jira-rules) - is a plugin that implement all jira commits messages style rules and validate commit messages
##### Configure commitlint to use jira commits messages style config
```js
// commitlint.config.js || commitlintrc.js
module.exports = {
plugins: ['commitlint-plugin-shr-jira'],
extends: ['jira-jquery'],
}
```
##### To lint commits before they are created you can use Husky's 'commit-msg' hook
```json
// package.json
{
"husky": {
"hooks": {
"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
}
}
}
```
## Rules
```bash
// You must follow this rule