Skip to content

vidavidorra/commitlint-config

Repository files navigation

commitlint configuration

commitlint configuration extending @commitlint/config-conventional.


npm version npm downloads Node.js version support Renovate enabled semantic-release Code coverage License

Install

npm install --save-dev @vidavidorra/commitlint-config @commitlint/cli

Usage

Use this configuration in your project's commitlint configuration by specifying it as item in the extends array (commitlint Shareable configuration).

Tip

You may use either just the scope, @vidavidorra, or the full path, @vidavidorra/commitlint-config, of the package.

module.exports = {
  extends: ['@vidavidorra'],
};

Documentation

See docs/rules for the configured rules.

Contributing

Please create an issue if you have a bug report or feature proposal, or create a discussion if you have a question. If you like this project, please consider giving it a star ⭐

Refer to the contributing guide detailed information about other contributions, like pull requests.

Conventional Commits: 1.0.0 XO code style Code style

Security policy

Please refer to the Security Policy on GitHub for the security policy.

License

This project is licensed under the GPLv3 license.

Copyright © 2020-2024 Jeroen de Bruijn

License details.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

The full text of the license is available in the LICENSE file in this repository and online.