为你的代码变更添加最佳注释：Git Commit Message 写作约定

在 Git 协作开发中，清晰明了的提交注释是必不可少的。本文将介绍如何撰写出最佳的 Git 提交注释，以便更好地理解代码变更并提高团队协作效率。

撰写清晰提交注释的意义

• 清晰的提交注释有助于其他开发者理解代码变更的内容和目的，从而减少代码审查和合并时的沟通成本。
• 有助于维护项目的历史记录，以便将来出现问题时能够快速追溯到代码变更的源头。
• 可以帮助自动化工具（如持续集成系统）更好地理解代码变更，从而提高自动化测试和部署的效率。

Git Commit Message 的格式约定

Git Commit Message 一般由以下三个部分组成：

1. 首行：简要说明本次提交的主要变更，通常以动词开头。
2. 正文：详细本次提交的具体内容和原因，可以分多行书写。
3. 结尾：列出本次提交所涉及的文件或代码行号。

Git Changelog 中的三个部分

在 Git Changelog 中，可以将提交注释分为三个部分：新功能、错误修复和破坏性更改（breaking change）。

• 新功能：添加或改进了项目的某个功能。
• 错误修复：修复了项目中的某个错误。
• 破坏性更改：对项目的现有功能或 API 进行了不向后兼容的更改。

这三个部分的内容可以由脚本生成，并指向相关提交的链接。当然，也可以在实际发布之前基于脚本生成骨架，手动编辑 CHANGELOG 的内容。

使用脚本生成 Git Changelog

有很多脚本工具可以帮助你自动生成 Git Changelog。例如，你可以使用以下命令使用 conventional-changelog 工具生成 Changelog：

npx conventional-changelog -p angular -i CHANGELOG.md -s

该命令将使用 Angular 约定生成 CHANGELOG.md 文件，并将其保存到当前目录。

手动编辑 Git Changelog

如果你希望对自动生成的 Changelog 进行手动编辑，可以按照以下步骤进行操作：

1. 使用文本编辑器打开 CHANGELOG.md 文件。
2. 在文件的顶部添加一个标题，例如 "Changelog"。
3. 在标题下面，添加三个部分：新功能、错误修复和破坏性更改。
4. 在每个部分中，列出本次发布中包含的提交。
5. 对于每个提交，写一个简短的，并提供指向相关提交的链接。
6. 保存文件。

总结

Git Commit Message 的编写约定对于保持代码库的清晰度和可维护性至关重要。通过遵循本文介绍的格式和约定，你可以撰写出清晰明了的提交注释，从而提高团队协作效率和代码质量。