Quartz 4

Git 提交规范

6 min read

如何编写标准化的 Git 提交消息 —— 介绍 Conventional Commits 规范

在团队协作开发中，良好的 Git 提交消息不仅有助于追溯代码更改，还能提高代码管理的效率。Conventional Commits 是一种简洁、清晰的提交消息格式标准，它能帮助开发者快速理解提交内容，自动化生成变更日志（CHANGELOG）以及管理版本号。本文将详细介绍如何使用这一规范撰写标准化的提交消息。

1. 提交消息的基本结构

Conventional Commits 规范要求提交消息遵循以下格式：

<type>(<scope>): <subject>
 
<body>
  • type: 提交类型，描述这次提交的目的。
  • scope: 影响范围，标明变更作用于哪个模块或功能。
  • subject: 提交的简要描述，一句话概括变更内容。
  • body: 具体的提交描述，解释为什么要做这些更改（可选）。

2. 常见的提交类型

提交类型用于表明每次提交的目的，以下是规范中常用的几种类型：

  • feat: 新增功能，适用于所有新特性或模块的开发。
  • fix: 修复 bug，适用于修正代码中的问题或错误。
  • docs: 修改文档内容，例如更新 README、代码注释。
  • style: 代码格式变动，不涉及业务逻辑的更改，如调整缩进或代码样式。
  • refactor: 代码重构，指对代码结构的优化，不影响功能和性能。
  • test: 增加或更新测试代码。
  • chore: 变动不影响源代码的其他修改，比如构建工具配置。
  • perf: 提升性能的代码修改。
  • ci: 持续集成相关的变动，如 CI 配置文件的更新。
  • build: 修改构建系统或依赖，例如升级某个依赖包。

3. 提交消息示例

为了更好地理解提交消息的写法，以下列举了几种常见的提交示例：

  1. 新增功能：

    feat(user): 增加用户登录功能

    此提交表示新增了用户登录的功能。

  2. 修复 bug：

    fix(auth): 修复了未登录时页面崩溃的问题

    此提交记录修复了用户未登录时导致页面崩溃的错误。

  3. 文档更新：

    docs(readme): 更新 README，补充安装步骤

    此提交记录对项目的 README 文档进行了更新，增加了安装步骤说明。

  4. 代码格式调整：

    style(css): 调整了 header 样式的缩进问题

    此提交记录了对 CSS 代码的格式调整，修正了样式缩进问题。

  5. 重构代码：

    refactor(profile): 优化用户资料页面的渲染逻辑

    此提交表示重构了用户资料页面的逻辑，优化了代码结构。

4. 提交规范的好处

使用标准化的提交消息不仅能为团队协作带来便利，还具有以下几大优势：

  • 提高可读性：开发人员能从提交日志中快速了解每次代码更改的目的和范围。
  • 自动化支持：结合 Conventional Commits，可以通过工具自动生成 CHANGELOG、版本号，并在 CI/CD 流程中加速发布流程。
  • 版本控制：在发布新版本时，依据提交消息自动确定是否为 patch、minor 或 major 版本更新。
  • 提高效率：其他开发者可以通过提交记录迅速定位问题，理解代码更改背后的动机。

5. 自动化工具

为了进一步规范提交消息，可以结合 Commitlint 等工具自动校验提交是否符合 Conventional Commits 规范。还可以通过 semantic-release 来实现自动生成版本号、变更日志和自动发布新版本的功能。

6. 结论

Conventional Commits 是一个小而美的提交规范，它通过规范化的格式提高了代码维护的效率。通过良好的提交记录，开发者可以更加轻松地理解项目的历史更改，同时帮助自动化工具进行版本管理。建议在团队中推广这一规范，以提升代码协作和管理的效率。

通过使用规范化的提交消息，你的项目会更加井井有条，也更易于维护。希望通过本文，你能在日常开发中灵活运用这一提交规范。

Graph View