更好的代码：撰写高质量 commit message 的技巧

为何 commit message 如此重要？

1. 代码可追溯性

提交信息有助于追溯代码库的历史，了解代码库是如何演进的，以便在需要时，可以回溯到代码库的某个特定状态。

2. 代码审查与代码合并

优秀的 commit message 可以为代码审查者和合并请求审查者提供必要的信息，帮助他们快速了解代码的改动，从而做出更明智的决策。

3. 版本控制系统管理

版本控制系统管理（VCS）系统（例如 Git）通过 commit message 来记录代码库的变化。因此，高质量的 commit message 不仅有助于代码的管理，而且有助于代码库的历史记录。

如何撰写高质量 commit message？

撰写高质量 commit message 的关键在于：清晰、简洁、有意义。

1. 清晰

优秀的 commit message 首先要清晰，也就是说，它应该准确地反映代码的改动，使用明确的语言和简洁的句式，避免使用模棱两可或容易混淆的表达。

2. 简洁

优秀的 commit message 应该简洁，也就是说，它应该用最少的文字来代码的改动。不要在 commit message 中包含无关的信息，例如个人感想、感谢语等。

3. 有意义

优秀的 commit message 应该有意义，也就是说，它应该能够帮助读者快速理解代码的改动，以及代码改动背后的原因和动机。避免使用空洞或无意义的词语，例如 "修复了一个 bug" 或 "改进代码性能"。

commit message 格式

commit message 一般由三部分组成：标题、主体和脚注。

1. 标题

标题是 commit message 的第一行，也是最重要的部分，它应该用简洁的语言概括代码的改动。标题的长度一般不超过 50 个字符，并且应该以动词开头。

2. 主体

主体是 commit message 的第二部分，它应该详细代码的改动，包括改动的具体内容、改动的原因和改动带来的影响。主体的长度一般不超过 72 个字符，并且应该使用 Markdown 格式进行排版。

3. 脚注

脚注是 commit message 的第三部分，它应该包含一些额外的信息，例如与代码相关的 issue 编号、代码审查者或其他贡献者的信息等。脚注的长度一般不超过 20 行，并且应该使用 Markdown 格式进行排版。

撰写 commit message 的技巧

1. 使用命令行提交工具

使用命令行提交工具（例如 Git）可以帮助你更轻松地撰写 commit message。这些工具通常提供了自动完成和语法检查功能，可以帮助你快速生成高质量的 commit message。

2. 使用代码模板

使用代码模板可以帮助你快速生成高质量的 commit message。代码模板通常包含一些预定义的字段，例如标题、主体和脚注。你只需要填写这些字段，就可以生成一个完整