https://github.com/open-turo/commitlint-config-conventional
Turo's overrides of @commitlint/config-conventional
https://github.com/open-turo/commitlint-config-conventional
commitlint linting-rules nodejs
Last synced: 4 months ago
JSON representation
Turo's overrides of @commitlint/config-conventional
- Host: GitHub
- URL: https://github.com/open-turo/commitlint-config-conventional
- Owner: open-turo
- License: mit
- Created: 2022-03-23T02:53:30.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-27T15:28:45.000Z (over 2 years ago)
- Last Synced: 2025-02-17T17:47:56.835Z (5 months ago)
- Topics: commitlint, linting-rules, nodejs
- Language: JavaScript
- Homepage:
- Size: 52.7 KB
- Stars: 0
- Watchers: 9
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# commitlint-config-conventional
This is an extension of the rules within @commitlint/config-conventional for
the purposes of overriding certain values as deemed necessary. Those rules
that this module is overriding are noted here:- `body-max-line-length` Increased to 300 characters to allow for commit messages that would otherwise exceed the 100 character limit.
[](https://github.com/open-turo/commitlint-config-conventional/releases/)
[](https://github.com/open-turo/commitlint-config-conventional/actions/)
[](./LICENSE)
[](https://github.com/dwyl/esta/issues)

[](https://github.com/semantic-release/semantic-release)
[](https://turo.com/jobs)## Node.js based project installation
The following commands will install this module for your Node.js based project if you are using `npm` or `yarn`, via the project's `package.json` file.
### npm installation
```
npm install --include=dev @open-turo/commitlint-config-conventional
```### yarn installation
```
yarn add @open-turo/commitlint-config-conventional -D
```## Usage
To make use of this module, simply include it in your conventional `.commitlintrc.yaml` file, as depicted below:
```
extends:
- "@open-turo/commitlint-config-conventional"
```