commitlint-config-silks v0.0.1

CommitLint 规范

是毛线前端 CommitLint 规范

安装

npm install commitlint-config-silks -D
# OR
yarn add commitlint-config-silks --dev

使用

在你的工程根目录下创建一个.commitlintrc.js配置文件

配置如下即可:

module.exports = {
  extends: "commitlint-config-silks",
};

:::caution 如果项目之前安装过 CommitLint 相关的包，建议卸载，避免引入不必要的包。如@commitlint/cli、@commitlint/config-conventional等，直接在 package.json 搜索commitlint，相关的包全部卸载 :::

规范

格式： <type>[(scope)]: <description>

示例

git commit -a -m 'build: xxxxx'
git commit -a -m 'feat(cli): xxxxx'

字段说明

type