Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/onify/commitlint-config
https://github.com/onify/commitlint-config
Last synced: about 5 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/onify/commitlint-config
- Owner: onify
- Created: 2023-07-18T04:53:32.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-19T00:21:11.000Z (over 1 year ago)
- Last Synced: 2023-07-19T01:22:27.581Z (over 1 year ago)
- Language: JavaScript
- Size: 23.4 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# @onify/commitlint-config
Shareable `commitlint` config enforcing [Conventional Commits](https://www.conventionalcommits.org/) thru extension of [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional). Use with [@commitlint/cli](https://www.npmjs.com/package/@commitlint/cli).
## Installation
```console
npm install @commitlint/cli https://github.com/onify/commitlint-config.git
```
## Usage
Best used with [husky](https://typicode.github.io/husky) as a `commit-msg` hook.
### With a dedicated Commitlint Config
Create a `commitlint.config.js` file on the root directory and extend with this package:
```js
module.exports = {
extends: ['@onify'],
};
```
### With package.json
In the `package.json` of your project
```json
{
"commitlint": {
"extends": ["@onify"],
}
}
```
## Valid Types
| Type | Description |
| --------- | --------------------------------------------------------------------------------------------------------------- |
| build | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) |
| chore | Changes to the build process or auxiliary tools and libraries such as documentation generation |
| ci | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) |
| **ui** | Changes that only affects the UI |
| docs | Documentation only changes |
| **dx** | Any changes or addition that improves developer experience |
| feat | A new feature |
| fix | A bug fix |
| **infra** | Changes to any infrastructure configuration files and/or scripts (example scopes: aws, heroku, azure, nginx) |
| perf | A code change that improves performance |
| refactor | A code change that neither fixes a bug nor adds a feature |
| revert | [Read here](https://www.conventionalcommits.org/en/v1.0.0/#how-does-conventional-commits-handle-revert-commits) |
| style | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) |
| test | Adding missing tests or correcting existing tests |
| **wip** | Work in progress. For partial progress that you want to sync on the remote repo. |
**Note:** Descriptions taken directly from [Angular's Commit Message Type Guidelines](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#type) except for types that are in **bold** characters as they are new types added by this config.