Commitizen 工具使用指南

简介

Commitizen 是一个用于标准化 Git 提交信息的工具，通过预定义的提交类型和规范，帮助开发者生成结构化、清晰的提交记录。

• 📌 核心功能: 自动补全提交类型、强制格式约束
• 🛠️ 适用场景: 团队协作、提交信息规范、CI/CD 集成

安装与配置

1. 安装 Commitizen:

   npm install --save-dev commitizen  
   

2. 初始化配置文件:

   npx commitizen init cz-conventional-changelog --config .czconfig  
   

3. 配置 .czconfig 文件内容示例:

   {  
     "path": "commitizen_tool_config_file",  
     "prompt": true  
   }  
   

使用示例

执行 npx commitizen 后，会弹出交互式命令行:

? Select the type of change you're committing:  
  feat: 新增功能  
  fix: 修复 bug  
  docs: 文档更新  
  style: 代码风格调整  

• ✅ 选择提交类型后，自动生成符合规范的提交信息
• 🔄 支持自定义模板（如：feat: add support for <feature>）

常见问题

• Q: 如何自定义提交类型？
  A: 修改 .czconfig 的 path 配置或扩展 types 字段
• Q: 与 conventional-changelog 有什么区别？
  A: Commitizen 提供了更友好的交互式界面，而 conventional-changelog 更侧重自动化生成 changelog

🔗 了解更多 Commitizen 高级用法

📌 注意：提交信息规范可结合 Conventional Commit 标准进一步优化。