Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/untile/commitlint-config-untile
https://github.com/untile/commitlint-config-untile
Last synced: 21 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/untile/commitlint-config-untile
- Owner: untile
- License: mit
- Created: 2022-03-18T16:05:00.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-01-08T03:51:39.000Z (about 2 years ago)
- Last Synced: 2024-12-19T21:35:56.308Z (28 days ago)
- Language: JavaScript
- Size: 297 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# commitlint-config-untile
Untile-flavored commitlint config.
## Installation
```sh
$ yarn add @commitlint/cli @untile/commitlint-config-untile --dev
```
## Usage
Create an `.commitlintrc.js` file with the following:
```js
module.exports = {
extends: ['@untile/commitlint-config-untile']
};
```
## Rules
- Commit header should start to: **Add|Bump|Fix|Improve|Release|Remove|Update**.
- Commit header must not be longer than **52** characters.
- Commit header must have **more than 1 word**.
- Commit body should be in sentence-case.
**NOTE**
Follow the [commitlint.js.org](https://commitlint.js.org/#/guides-local-setup?id=install-husky) guide
to see how to finish the configuration, using for example husky.
## Releases
Be sure to have configured `NPM_TOKEN` in your globals.
```bash
npm version [ | major | minor | patch] -m "Release %s"
git push origin master && git push --tags
```