正确的 Git Commit 消息 - Shell/Bash

介绍

在使用 Git 进行版本控制时，编写规范的 Git Commit 消息非常重要。一个好的 Git Commit 消息能够帮助团队成员快速了解修改的内容，便于代码维护、代码审查以及问题追踪。本文将介绍如何编写规范的 Git Commit 消息，并提供一些示例和最佳实践。

Git Commit 消息格式

一个规范的 Git Commit 消息通常由三个部分组成：标题、正文和页脚(可选)。以下是每个部分的详细说明：

标题

Git Commit 消息的标题应该简明扼要地描述修改的内容。建议使用动词开头的命令式语气，如"添加"、"修复"、"更新"等。标题只能使用一行，长度不超过50个字符，并且不以句号结尾。

示例：添加新功能: 用户登录

正文

Git Commit 消息的正文部分用于提供更详细的描述。可以按需添加多行正文，每行不超过72个字符。正文应该解释修改的原因、具体的改动内容、是否有副作用等信息。

示例：

• 修复了用户登录时出现的错误提示
• 添加了用户密码加密的功能
• 更新了登录页面的样式

页脚（可选）

Git Commit 消息的页脚部分可以用于提供一些额外的信息，例如关联的 Issue、任务编号、合作伙伴等。页脚通常以"关键字: 内容"的形式呈现。

示例：

• 关闭 Issue #123
• Reviewed By: John Smith

代码片段

以下是一个示例的 Git Commit 消息代码片段，按照 Markdown 格式排版：

## 添加新功能：用户登录

- 修复了用户登录时出现的错误提示
- 添加了用户密码加密的功能
- 更新了登录页面的样式

关联 Issue #123
Reviewed By: John Smith

最佳实践

以下是一些编写规范的 Git Commit 消息的最佳实践：

• 提供清晰的标题，描述修改的核心内容
• 使用适当的动词以及命令式语气
• 在正文中提供详细的改动说明，解释修改的原因和影响
• 可选地使用页脚提供相关的额外信息
• 遵循团队约定的格式和风格

通过使用规范的 Git Commit 消息，团队成员能够更好地协作、追踪问题和理解代码变更，从而提高代码质量和开发效率。