English | 简体中文

@0x219/commitlint-config

⚙️ A shareable commitlint config enforcing conventional commits.

Getting started

Install the package in your project directory with:

// with npm
npm install @commitlint/cli @0x219/commitlint-config --save-dev

// with yarn
yarn add @commitlint/cli @0x219/commitlint-config --save-dev

In commitlint.config.js:

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

Rules

The most common commit conventions follow this pattern:

<type>[optional scope]: <subject>

[optional body]

[optional footer(s)]

Type

Type cannot be empty, must be lowercase.（build | break | chore | ci | docs | feat | fix | perf | refactor | revert | release | style | test | wip）

Subject

The subject cannot be empty and cannot end with. Never allowed "sentence-case", "start-case", "pascal-case", "upper-case".

Body

There must be a space before the body, and the maximum length is 100.

Footer

There must be a space before the footer, and the maximum length is 100.

Thanks

commitlint - 📓 Lint commit messages.

License

MIT ⓒ Taoist Priest