https://github.com/hadenlabs/commitlint-config
Shareable commitlint config used by Hadenlabs 🚀
https://github.com/hadenlabs/commitlint-config
commitlint commitlint-config git hadenlabs lint peru
Last synced: 10 months ago
JSON representation
Shareable commitlint config used by Hadenlabs 🚀
- Host: GitHub
- URL: https://github.com/hadenlabs/commitlint-config
- Owner: hadenlabs
- License: lgpl-3.0
- Created: 2021-03-17T03:25:47.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-01-26T20:22:31.000Z (about 1 year ago)
- Last Synced: 2025-04-12T22:15:26.216Z (10 months ago)
- Topics: commitlint, commitlint-config, git, hadenlabs, lint, peru
- Language: JavaScript
- Homepage:
- Size: 351 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: docs/code_of_conduct.md
Awesome Lists containing this project
README
[](https://github.com/hadenlabs/commitlint-config/releases) [](https://github.com/hadenlabs/commitlint-config/actions?workflow=lint-code) [](https://github.com/hadenlabs/commitlint-config/actions?workflow=ci) [](https://github.com/hadenlabs/commitlint-config/actions?workflow=test) [](https://github.com/pre-commit/pre-commit) [](https://conventionalcommits.org) [](https://keepachangelog.com)
# commitlint-config
commitlint-config for project
## Requirements
This is a list of plugins that need to be installed previously to enjoy all the goodies of this configuration:
- [gomplate](https://github.com/hairyhenderson/gomplate)
- [python](https://www.python.org)
- [taskfile](https://github.com/go-task/task)
## Installation
### [yarn](https://yarnpkg.com)
If you're using [yarn](https://yarnpkg.com)
```shell
yarn add --dev husky @commitlint/cli @commitlint/config-conventional @hadenlabs/commitlint-config
```
### [npm](https://www.npmjs.com)
If you're using [npm](https://www.npmjs.com)
```shell
npm i --save-dev husky @commitlint/cli @commitlint/config-conventional @hadenlabs/commitlint-config
```
## Usage
# How to use this project
Create file `.commitlintrc.json` with extending preset and define set of scopes:
```json
{
"extends": ["@hadenlabs/config-conventional"],
"rules": {
"type-enum": [
2,
"always",
[
// as examples
"app",
"common"
]
]
}
}
```
Add to `package.json` next section:
```json
{
"husky": {
"hooks": {
"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
}
}
}
```
## Examples
### Common
## Help
**Got a question?**
File a GitHub [issue](https://github.com/hadenlabs/commitlint-config/issues).
## Contributing
See [Contributing](./docs/contributing.md).
## Module Versioning
This Module follows the principles of [Semantic Versioning (SemVer)](https://semver.org/).
Using the given version number of `MAJOR.MINOR.PATCH`, we apply the following constructs:
1. Use the `MAJOR` version for incompatible changes.
1. Use the `MINOR` version when adding functionality in a backwards compatible manner.
1. Use the `PATCH` version when introducing backwards compatible bug fixes.
### Backwards compatibility in `0.0.z` and `0.y.z` version
- In the context of initial development, backwards compatibility in versions `0.0.z` is **not guaranteed** when `z` is increased. (Initial development)
- In the context of pre-release, backwards compatibility in versions `0.y.z` is **not guaranteed** when `y` is increased. (Pre-release)
## Copyright
Copyright © 2018-2025 [Hadenlabs](https://hadenlabs.com)
## Trademarks
All other trademarks referenced herein are the property of their respective owners.
## License
The code and styles are licensed under the LGPL-3.0 license [See project license.](LICENSE).
## Don't forget to 🌟 Star 🌟 the repo if you like commitlint-config
[Your feedback is appreciated](https://github.com/hadenlabs/commitlint-config/issues)