commitlint-config-gofund

本包提供了《朝阳永续基金线前端规约 - Git 规约》配套的 commitlint 可共享配置，用于对 git commit message 进行校验。

安装

除了本包，你需要同时安装 @commitlint/cli：

npm install commitlint-config-gofund @commitlint/cli --save-dev

使用

在你的 commitlint.config.js 中继承本包:

module.exports = {
  extends: ['gofund'],
};

设置 git hook

可通过 husky 设置在 git commit 时触发 commitlint。

首先安装 husky：

npm install husky --save-dev

然后在 .husky 目录下增加文件commit-msg：

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

更多信息可参考 commitlint 文档。