如何编写优雅的 Commit Message：提升代码质量的秘诀

1. 明确 Commit Message 的结构

一个好的 commit message 通常遵循特定的结构。我们建议采用“标题”、“正文”、“脚注”三部分的格式：

• 标题：简洁地描述本次提交的目的，通常限制在50个字符之内。使用动词开头，采取简洁而精确的语气。
• 正文：详细说明变更的原因及其影响，推荐使用72个字符为一行，以便在终端和邮件中显示时更美观。
• 脚注：提供任何额外信息，如关联的 Issue 编号、破坏性变更的免责声明等。

示例：

修复用户登录时的崩溃问题

用户在使用社交媒体账户登录时，可能会因 API 响应错误而导致应用崩溃。修复了此问题，确保用户能顺利登录。

关联 Issue #145

2. 使用动词开头的有效标题

标题应明确说明变更内容，且可用动词开头，常用的动词包括“修复”、“新增”、“删除”等。这样的写法能让读者迅速把握更改的核心。

示例：

• 新增功能：用户权限管理
• 修复错误：邮件发送失败
• 优化：提升页面加载速度

3. 清晰描述变更的原因和影响

在正文部分，花一些时间详细说明为什么做出这些变更，以及它们可能带来的影响。这对于后续的维护和升级至关重要。

示例：

在用户登录时，修复了对社交媒体 API 的请求，避免因网络延迟导致崩溃现象。此提交还优化了登录流程，提高了用户体验。

4. 避免使用模糊语言

在撰写 commit message 时，避免使用模糊不清的措辞，如“修复了一些问题”或“调整了一些设置”。这些表达无法提供足够的信息，使得其他开发者在阅读历史记录时感到困惑。

明确示例：

错误修复：修复了在特定情况下无法保存用户设置的错误

5. 一次只提交一个功能或问题

虽然可能在同一时间内处理多个问题，但在提交时建议尽量将每个提交限于一个主题或功能。这样使得回退某个特定的更改时更加简单。

示例：

新增：用户注册功能
修复：用户登录时的崩溃问题

6. 纠正和更新 Commit Message

如果在提交后发现 commit message 中存在错误或不清晰的地方，可以使用 git commit --amend 命令来进行修改。在团队协作中，良好的记录是维护项目的重要部分，不要忽视这一步骤。

7. 借鉴最佳实践与团队约定

不同的团队可能有自己的约定和标准，可以考虑采纳业界的最佳实践并根据团队需求进行调整。例如，采用“Conventional Commits”规范，可以让你的 commit message 更加规范化和一致。

总结

优雅的 commit message 是高质量代码的表现，它能够提升团队的协作效率、改善项目的可维护性。在日常的开发过程中，花一点时间来撰写清晰、简洁且富有意义的 commit message，将会对你和你的团队带来长久的益处。希望以上的建议能够帮助你更好地书写 commit message，使得代码版本控制更加高效。