mirror of
https://github.com/ivuorinen/base-configs.git
synced 2026-01-26 11:14:00 +00:00
63 lines
2.2 KiB
Markdown
63 lines
2.2 KiB
Markdown
# @ivuorinen/commitlint-config <!-- omit in toc -->
|
|
|
|
[![npm package][npm-badge]][npm-link] [![license MIT][license-badge]][license-link] [![ivuorinen's Code Style][style-badge]][style-link]
|
|
|
|
> ivuorinen's shareable configuration for [`CommitLint`][commitlint-link].
|
|
|
|
## Table of Contents <!-- omit in toc -->
|
|
|
|
- [Installation](#installation)
|
|
- [Documentations](#documentations)
|
|
- [Contributing](#contributing)
|
|
- [Changelog](#changelog)
|
|
- [License](#license)
|
|
|
|
## Installation
|
|
|
|
Install `this config` as a _`devDependencies`_:
|
|
|
|
```sh
|
|
# npm
|
|
npm install @ivuorinen/commitlint-config --save-dev
|
|
|
|
# Yarn
|
|
yarn add @ivuorinen/commitlint-config --dev
|
|
```
|
|
|
|
After installing it, a _`.commitlintrc.json`_ file will be created automatically in the project's root folder with the following configuration:
|
|
|
|
```json
|
|
{
|
|
"extends": ["@ivuorinen/commitlint-config"]
|
|
}
|
|
```
|
|
|
|
## Documentations
|
|
|
|
Read the [CommitLint docs][commitlint-docs-link] for more information.
|
|
|
|
## Contributing
|
|
|
|
If you are interested in helping contribute, please take a look at our [contribution guidelines][contributing-link] and open an [issue][issue-link] or [pull request][pull-request-link].
|
|
|
|
## Changelog
|
|
|
|
See [CHANGELOG][changelog-link] for a human-readable history of changes.
|
|
|
|
## License
|
|
|
|
Distributed under the MIT License. See [LICENSE][license-link] for more information.
|
|
|
|
[changelog-link]: ./CHANGELOG.md
|
|
[commitlint-docs-link]: https://commitlint.js.org
|
|
[commitlint-link]: https://github.com/conventional-changelog/commitlint
|
|
[contributing-link]: https://github.com/ivuorinen/.github/blob/main/CONTRIBUTING.md
|
|
[issue-link]: https://github.com/ivuorinen/base-configs/issues
|
|
[license-badge]: https://img.shields.io/github/license/ivuorinen/base-configs?style=flat-square&labelColor=292a44&color=663399
|
|
[license-link]: ./LICENSE
|
|
[npm-badge]: https://img.shields.io/npm/v/@ivuorinen/commitlint-config?style=flat-square&labelColor=292a44&color=663399
|
|
[npm-link]: https://www.npmjs.com/package/@ivuorinen/commitlint-config
|
|
[pull-request-link]: https://github.com/ivuorinen/base-configs/pulls
|
|
[style-badge]: https://img.shields.io/badge/code_style-ivuorinen%E2%80%99s-663399.svg?labelColor=292a44&style=flat-square
|
|
[style-link]: https://github.com/ivuorinen/base-configs
|