好的提交消息

对于遍历 git log 的人来说,轻松理解每个提交的内容非常重要。良好的提交消息通常包括跟踪器中的许多任务或问题,以及已完成的内容和原因的简明描述,有时还包括如何完成。

更好的消息可能如下所示:

TASK-123: Implement login through OAuth
TASK-124: Add auto minification of JS/CSS files
TASK-125: Fix minifier error when name > 200 chars

以下消息不太有用:

fix                         // What has been fixed?
just a bit of a change      // What has changed?
TASK-371                    // No description at all, reader will need to look at the tracker themselves for an explanation
Implemented IFoo in IBar    // Why it was needed?

测试提交消息是否以正确的心情编写的方法是用消息替换空白并查看是否有意义:

如果我添加此提交,我将___到我的存储库

一个伟大的 git 提交消息的七个规则

  1. 用空行将主题线与主体分开
  2. 将主题行限制为 50 个字符
  3. 资本化主题
  4. 不要以句点结束主题行
  5. 使用主题行中的命令式情绪
  6. 手动将身体的每一行包裹在 72 个字符处
  7. 用身体来解释什么为什么而不是如何

Chris Beam 的博客中有 7 条规则