基础设置
首先,让我们安装 Commitizen 并设置默认的提交信息适配器:
-
全局安装 Commitizen:
npm install -g commitizen
-
全局安装
cz-conventional-changelog
作为默认适配器:npm install -g cz-conventional-changelog echo '{ "path": "cz-conventional-changelog" }' > ~/.czrc
这两步为我们的 Git 提交流程打下了基础,确保我们能够生成遵循 Conventional Commits 规范的提交信息。
增添 Emoji
如果想在提交信息中使用 emoji ,我们可以安装 cz-emoji
:
npm install -g cz-emoji
echo '{ "path": "cz-emoji" }' > ~/.czrc # 使用 cz-emoji 更新 .czrc
这一步让我们的提交信息更加生动,有助于快速识别提交类型。
自定义提交信息
如果默认的规范不完全符合我们的需求,或者我们想进一步自定义提交信息,包括添加自定义 emoji,cz-customizable
提供了极大的灵活性:
-
安装
cz-customizable
以支持自定义格式:npm install -g cz-customizable echo '{ "path": "cz-customizable" }' > ~/.czrc # 使用 cz-customizable 更新 .czrc
-
在你的用户目录或项目根目录下创建
.cz-config.js
文件,定义你的提交规范。一个简单的
.cz-config.js
示例配置:module.exports = { types: [ { value: 'feat✨', name: 'feat✨: 新功能 (feature)' }, { value: 'fix🐛', name: 'fix🐛: 修复 (bug fix)' }, // 更多自定义类型... ], // 自定义配置... };
完整示例可参考:cz-customizable 示例配置。
使用 git cz
有了上述配置,无论是在哪个项目中,你都可以通过 git cz
命令来替代 git commit
,Commitizen 会引导你完成规范、表达性强的提交信息。
注意事项
- 在切换到
cz-emoji
或cz-customizable
后,记得更新.czrc
以指定使用的适配器。 - 若在项目级别使用特定配置,确保相应的适配器作为开发依赖安装在项目中,并通过项目的
package.json
进行配置。
总结
通过 Commitizen 与其适配器,我们可以极大地简化和优化 Git 提交流程。无论你是倾向于遵循标准的 Conventional Commits 规范,还是偏好通过 emoji 和自定义格式来丰富你的提交信息,这些工具都能帮助你实现目标,提升项目的管理效率和协作体验。
希望这篇指南能帮助你高效地管理你的 Git 提交历史,让它成为项目管理中不可或缺的一部分。