规范你的代码——Commitizen

在上一期文章中，我们探讨了如何使用 Husky 规范开发中的代码格式。今天，我们将继续深入探讨，重点关注如何让你的仓库中的提交也规范起来。

何为规范化提交？

规范化提交是指遵循一套既定的指南来撰写提交消息，这有助于保持代码仓库的整洁有序。规范化提交可以提高协作效率，因为它们让每个人都能轻松理解提交的目的和影响。

Commitizen 简介

Commitizen 是一个工具，它可以帮助你轻松撰写规范化的提交消息。它通过提供一系列提示和验证来指导你完成提交消息的撰写过程。

使用 Commitizen

要开始使用 Commitizen，你需要先全局安装它：

npm install -g commitizen

安装完成后，你可以在你的项目中初始化一个 Commitizen 配置文件：

cd my-project
commitizen init

这将创建一个 .czrc 文件，其中包含 Commitizen 的配置选项。

撰写规范化的提交消息

使用 Commitizen 撰写规范化的提交消息非常简单。只需运行以下命令：

git cz

这将启动 Commitizen 交互式提示。提示将引导你完成一系列问题，包括提交类型（例如修复、特性）、范围（例如特定模块或功能）和提交说明。

Commitizen 将根据你的回答生成一个规范化的提交消息，该消息遵循 Conventional Commits 规范。

Conventional Commits 规范

Conventional Commits 规范定义了提交消息的结构，使其更容易理解和解析。它规定提交消息应由以下部分组成：

• 类型：表示提交的目的（例如修复、特性、重构）
• 范围：指定受提交影响的模块或功能
• 说明：简要提交所做的更改
• 正文（可选）：更详细地解释提交
• 页脚（可选）：引用相关的问题或讨论线程

例如，一个遵循 Conventional Commits 规范的提交消息可能如下所示：

feat(ui): Add new button to the header

Adds a new "Log In" button to the header, allowing users to easily access their accounts.

好处

使用 Commitizen 和 Conventional Commits 规范有很多好处，包括：

• 提高协作效率： 规范化的提交消息让每个人都能轻松理解提交的目的和影响，从而提高协作效率。
• 自动化处理： Commitizen 可以与自动化工具集成，例如持续集成系统，以自动执行提交消息验证和处理。
• 可追溯性： 规范化的提交消息有助于提高代码库的可追溯性，因为它使你能够轻松地跟踪更改并了解其原因。
• 代码质量： 规范化的提交消息鼓励开发者在提交代码时更加周到和细心，这可以提高整体代码质量。

结论

通过使用 Commitizen 和 Conventional Commits 规范，你可以轻松地规范仓库中的提交，提高协作效率，并提高代码质量。