cz-git 使用指南

1. 项目介绍

cz-git 是一款基于 Node.js 的 Git 提交命令行工具，旨在提升开发体验（DX），它是一款轻量级且高度可定制的 Commitizen 适配器和 CLI。此工具专注于遵循 Conventional Commits 规范，同时通过 OpenAI 支持来帮助自动化生成提交消息，使得开发者能够更高效地进行版本管理，减少拼写错误，并在命令行上提供搜索和选择功能。对于那些追求工程效率的团队和单个开发者来说，cz-git 是一个理想的选择，尤其适合于使用 Monorepo 和集成 CommitLint 的项目。

2. 快速启动

要快速开始使用 cz-git，请确保你的环境已经安装了 Node.js 版本不低于 v12.20。之后，你可以按照以下步骤操作：

安装 cz-git

在你的项目目录下，使用 npm 或 yarn 来全局或局部安装 cz-git：

局部安装（推荐用于项目内部）

npm install --save-dev cz-git

全局安装（如果你希望在任何项目中方便使用）

npm install -g cz-git

配置你的 Commitizen

在项目根目录下创建或修改 .czrc.json 文件，指定 cz-git 作为默认的 Commitizen 适配器：

{
  "path": "cz-git"
}

完成以上步骤后，你就可以使用 git cz 命令来开始一个交互式的提交过程了，它将引导你创建符合规范的提交消息。

3. 应用案例和最佳实践

当使用 cz-git 时，最佳实践包括：

• 利用 OpenAI 助力: 在提交过程中尝试输入关键字，OpenAI 将帮助生成更标准的提交描述。
• 遵循 Conventional Commits 规范: 使用类型（如 feat、fix、docs等）来明确你的提交意图。
• 利用预览: 在提交前查看消息，确保其准确无误并符合预期。
• 结合 CommitLint: 对提交消息进行自动检查，以保持一致性。

4. 典型生态项目

cz-git 已经被一些显著的项目所采用，其中包括但不限于：

• Nx: 大型项目及Monorepo的构建工具。
• Element Plus: Vue.js的UI框架。
• Ant Design Vue: 著名的Vue组件库。
• TDesign-Vue-Next: 新一代Vue设计系统。
• Vben-Admin: Vue.js的后台管理系统模板。

这些项目采用cz-git，体现了其在实际开发中的实用性和广泛适用性，特别是在追求高质量Git提交日志的现代化工程实践中。

---

通过上述步骤和建议，您可以迅速地将 cz-git 整合到您的日常开发流程中，享受更加高效和标准化的提交管理体验。