git-cz
:用于生成符合 Conventional Commits 标准的提交消息的工具,以便更规范地记录项目的提交历史。
配置:
-
安装
commitizen
和cz-customizable
:npm install --save-dev commitizen cz-customizable
-
在
package.json
中配置config.commitizen
:在
package.json
文件中添加如下配置:"config": { "commitizen": { "path": "./node_modules/cz-customizable" } }
-
添加
.cz-config.js
文件:在项目根目录下创建一个
.cz-config.js
文件,用于配置提交信息的规范。以下是一个示例配置:javascriptCopy code module.exports = { types: [ { value: 'feat', name: 'feat: 新增功能' }, { value: 'fix', name: 'fix: 修复 bug' }, { value: 'docs', name: 'docs: 文档变更' }, { value: 'style', name: 'style: 代码格式变更(不影响功能,比如空格、格式化、缺失的分号等)' }, { value: 'refactor', name: 'refactor: 代码重构' }, { value: 'perf', name: 'perf: 性能优化' }, { value: 'test', name: 'test: 添加或修改测试' }, { value: 'chore', name: 'chore: 构建过程或辅助工具的变更' }, { value: 'revert', name: 'revert: 回滚到上一个版本' } ], allowCustomScopes: true, allowBreakingChanges: ['feat', 'fix'] };
这里定义了一些常见的提交类型和相关的说明。
-
使用
git-cz
进行提交: 引导生成符合规范的提交信息。替代使用
git commit
,运行以下命令来使用git-cz
:npx git-cz
-
提交到版本库:
生成的提交信息将自动添加到版本库,之后可以继续推送到远程仓库。