Superbet Shared Commitlint Config

Commitlint is a commit message linter.

• Committing the code guide

What it does?

• Extends @commitlint/config-conventional
• Adds a rule that enforces fix and feat commits to have a Jira ticket id at the end in square brackets.

Allowed commits

docs: fixed typo in readme
feat: infantry units move 10% faster [ABC-123]

Disallowed commits

fix: ships no longer count as infantry

Add to a Project

Install Configuration

npm i @commitlint/{config-conventional,cli} @superbet/commitlint-config --save-dev

Add to Commitlint Config

module.exports = {
  extends: ["@superbet/commitlint-config"],
};

Using .commitlintrc.js

Add to Husky

npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'

Suggestions?

Create a discussion on GitHub or learn how to make a contribution.