原文地址 Writing good commit messages

好的commit信息至少有三个目的:

• 加快代码review过程
• 帮助我们编写好的release
• 为了帮助Erlang / OTP的未来维护者（可能是你！），未来五年，找出为什么对代码进行特定更改或为什么添加了特定功能。

像这样构建您的提交消息：
From: http://git-scm.com/book/ch5-2.html

1
2
3
4
5

50字以内的变更摘要
如有必要，更详细的说明文字

更多的描述出现在空行之后
- Bullet points也可以

可以

• 在命令行模式写下你已经做完的任务的总结和描述，就好像你在给某人指令。使用 ‘Fix’, ‘Add’, ‘Change’开头，而不是‘Fixed’, ‘Added’,’Changed’
• 第二行要留白
• 提交的信息要换行

不可以

• 不要以句号作为行的结尾，因为这是一个title

Tips

• 如果总结你的提交看起来很困难，可能是因为它包含了几个逻辑更改或错误修复，并且使用git add -p更好地分成几个提交。

参考

以下博客文章对commit message进行了很好的讨论：http://who-t.blogspot.com/2009/12/on-commit-messages.html