commitlint.config.js

// build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
// chore : Installing new dependencies, or bumping deps
// ci: Changes to our CI configuration files and scripts (Ex: GitHub workflows, Husky, Travis, Circle)
// docs: Documentation only changes. Ex: README.md
// feat : Changes about feature addition or removal. Ex: `feat: add table on landing page`, `feat: remove table from landing page`
// fix : Bug fix, followed by the bug. Ex: `fix: illustration overflows in mobile view`
// perf : Code change regarding performance (deriving state, using memo, callback)
// refactor: A code change that neither fixes a bug nor adds a feature
// revert : When reverting commits
// style: Changes that do not affect the meaning of the code (white-space, formatting, missing semicolons, removing comments etc.)
// test: Adding missing tests or correcting existing tests

module.exports = {
  extends: ["@commitlint/config-conventional"],
  rules: {
    // 'scope-enum': [2, 'always', ['yourscope', 'yourscope']],
    "type-enum": [
      2,
      "always",
      [
        "build",
        "chore",
        "ci",
        "docs",
        "feat",
        "fix",
        "perf",
        "refactor",
        "revert",
        "style",
        "test",
      ],
    ],
  },
};