如何在 Git 书写良好的 Commit Messages

如何在 Git 书写良好的 Commit Messages

Why(为什么编写) | How(如何编写)

Why

A diff will tell you what changed, but only the commit message can properly tell you why

良好的 Messages 可以告诉人们变更的原因，更好高效地理解几个月前甚至几年前发生的事情。

• 风格的一致性：语法，大小写，行距，标点符号等；
• 内容：该提交的信息和不该提交的信息；
• 元数据：清晰可追踪；

How

提交准则 | Time Pope 提供的一个模板

• 首行：以少于 50 个字符（25个汉字）的单行开始且简要地描述变更；
  • 首字母大写；
  • 不以句号 (period) 结尾；
  • 使用祈使语气，如 Add new object ；
• 空白行：将前后分隔开；
• 解释部分：对所作变动更详细的解释
  • 与之前行为的对比，如使用“Fix bug”而非“Fixed bug”或“Fixes bug”；
  • 72 个字符的时候手动换行；
  • 说明是什么 (what) 以及为什么 (why)，不用说明这么操作的原理 (how)；
  • Explain what and why vs. how