https://github.com/bonzaico/commitlint-config-bonzai
Shareable commitlint config used at Bonzai.
https://github.com/bonzaico/commitlint-config-bonzai
bonzai commit commitlint conventions git lint
Last synced: 3 months ago
JSON representation
Shareable commitlint config used at Bonzai.
- Host: GitHub
- URL: https://github.com/bonzaico/commitlint-config-bonzai
- Owner: bonzaico
- License: bsd-3-clause
- Created: 2018-11-02T10:53:27.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-11-02T10:57:08.000Z (over 7 years ago)
- Last Synced: 2025-03-20T03:04:20.773Z (over 1 year ago)
- Topics: bonzai, commit, commitlint, conventions, git, lint
- Language: JavaScript
- Size: 1.95 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# commitlint-config-bonzai
Shareable commitlint config used at Bonzai.
Use with [@commitlint/cli](https://npm.im/@commitlint/cli) and [@commitlint/prompt-cli](https://npm.im/@commitlint/prompt-cli).
## Getting started
Install the package
```sh
npm install --save-dev commitlint-config-bonzai @commitlint/cli
```
Create a file `commitlint.config.js` and set it's contents as
```javascript
module.exports = {
extends: ["commitlint-config-bonzai"],
"scope-enum": [
1,
"always",
["all", "dev"]
]
};
```
This configuration only specifies the message format but does not define the allowed scopes, because
they will vary with project.