README.zh-Hans.md

English | 简体中文

@0x219/commitlint-config

⚙️ 一个强制执行约定式提交的可共享 commitlint 配置。

快速开始

使用以下命令在项目目录中安装包：

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

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

在 commitlint.config.js 中:

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

规则

最常见的提交约定遵循以下模式：

<类型>[可选 范围]: <描述>

[可选 正文]

[可选 脚注]

类型

类型不能为空，必须是小写。（build | break | chore | ci | docs | feat | fix | perf | refactor | revert | release | style | test | wip）

描述

描述不能为空，也不能以.结束， 不允许“句子大小写”、“开始大小写”、“大写驼峰”、“大写字母”。

正文

可选，正文前必须有一个空格，最大长度为100。

脚注

可选，正文前必须有一个空格，最大长度为100。

致谢

commitlint - 📓 Git提交消息分析工具

许可证

MIT ⓒ Taoist Priest