Git 好的提交信息

示例

对于一个遍历的人来说,重要的是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                         // 修复了什么?
just a bit of a change      // 有什么变化?
TASK-371                    // 完全没有描述,读者将需要自己查看跟踪器以获得解释
Implemented IFoo in IBar    // 为什么需要它?

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

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

优秀的git commit消息的七个规则

  1. 用空白行将主题行与正文分开

  2. 将主题行限制为50个字符

  3. 大写主题行

  4. 主题行不要以句号结尾

  5. 在主题行中使用命令式语气

  6. 手动将正文的每一行换成72个字符

  7. 用身体来解释什么为什么而不是如何

克里斯·比姆(Chris Beam)博客的7条规则。