https://github.com/team23/commitlint-config

TEAM23 configuration for commitlint
https://github.com/team23/commitlint-config

Last synced: about 22 hours ago
JSON representation

TEAM23 configuration for commitlint

• Host: GitHub
• URL: https://github.com/team23/commitlint-config
• Owner: team23
• License: mit
• Created: 2022-12-22T15:55:36.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-03-01T13:00:07.000Z (over 1 year ago)
• Last Synced: 2024-04-26T21:45:38.531Z (7 months ago)
• Language: JavaScript
• Size: 15.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# commitlint-config

TEAM23 configuration for [commitlint](https://commitlint.js.org/) enforcing our [commit standard](https://confluence.team23.de/display/AP/Commit+Standard).

## How to use with [pre-commit](https://pre-commit.com/)

### Create config file

Add a file `commitlint.config.js` to the root directory of your project with the following content: 

```js

module.exports = {

    extends: ['@team23/commitlint-config'],

};

```

### Add pre-commit hook

Next, add the pre-commit hook for commitlint to your pre-commit config (`.pre-commit-config.yaml`) by adding

```yaml

  - repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook

    rev: v9.0.0

    hooks:

      - id: commitlint

        stages: [commit-msg]

        additional_dependencies:

          - "@team23/[email protected]"

```

Specify the version of `@team23/commitlint-config` you want to use in the `additional_dependencies`.