如何写出好的提交信息

提交消息是在提交更改之前添加的对文件所做更改的简短描述。

良好的提交信息不仅对项目中与您合作的其他人来说很重要，而且对您自己也很重要，因为它可以跟踪您的所有提交，并准确了解在特定提交期间可能发生的更改。

即使您正在从事个人项目，我也建议您养成编写良好提交信息的习惯。

这是我大多数时候使用的格式（这可能会根据您的偏好或您工作的组织而改变）：

type: subject

body (optional)

footer (optional)

1.类型

• feat——一项新功能
• 修复- 错误修复
• docs - 文档的变更
• 风格——与造型相关的一切
• 重构- 代码更改既不修复错误也不添加功能
• 测试——与测试相关的一切
• 杂务- 更新构建任务、包管理器配置等

2. 主题

这包含对所做更改的简短描述。描述不应超过 50 个字符，应以大写字母开头，并使用祈使语气，例如，使用 Add 而不是 Added 或 Adds。

3. 身体

正文用于解释您所做的更改以及更改的原因。并非所有提交都足够复杂，需要正文，尤其是在您独自进行个人项目时，因此编写正文是可选的。

正文与主题之间需有一个空行，每行不超过 72 个字符。

4. 页脚

页脚也是可选的，主要用于您使用问题跟踪器引用问题 ID 时。

Udacity 学生使用的良好提交消息示例Udacity Git 提交消息样式指南

feat：用大约 50 个字符或更少的字符总结变化

如有必要，请提供更详细的说明文字。请将其换行至大约 72 个
字符左右。在某些情况下，第一行被视为
提交的主题，其余文本被视为正文。
将摘要与正文分隔开的空行至关重要（除非
您完全省略正文）；如果您同时运行这两个工具，例如log、shortlog
和 ，它们rebase可能会产生混淆。

解释一下这次提交要解决的问题。重点说明你为什么
要做这个修改，而不是如何做（代码已经解释了）。
这个修改是否有副作用或其他不直观的后果
？这里就是向他们解释的地方。

空白行之后是其他段落。

• 要点也可以

• 通常使用连字符或星号作为项目符号，前面
  有一个空格，中间有空行，但
  这里的惯例有所不同

如果您使用问题跟踪器，请将对它们的引用放在底部，
如下所示：

决议：#123
另请参阅：#456、#789

一个更实际的例子：

文档：修复 README.md 中的拼写错误