良好的提交信息有助于沟通协作

清晰的提交（commit）消息可以极大地帮助开发人员，这篇简短的博客将分享一些为 openSUSE 和开源贡献编写高质量提交消息的最佳实践。

提交消息用于在团队成员之间传达重要信息，并且由于开源软件是一个专注于开放协作的大团队，因此必须在这些消息中传达上下文。

为什么？

“为什么？” 现在对你来说可能很明显，但对其他人来说可能不是；特别是那些甚至可能还没有参与你的代码的人。精心编写的提交消息可帮助开发人员记住先前提交的各个方面，并帮助未来的开发人员了解更改的内容和更改的目的。

提交消息并没有统一的结构和格式规范，但多花一点时间和精力修整提交信息就可以使世界全然不同。你可以考虑以一种直截了当的方式编写提交消息；有点像教官下达命令或指示。如，擦亮你的靴子。清洁厕所。做俯卧撑。更具体地说，想想父母告诉他们的孩子做什么以及为什么。如，清洁炉子，因为您洒在上面的食用油可能会导致下一个使用它的人着火。

下面是一些其他有助于编写一份良好的提交消息的提示。

重要的事

• 除了说明“发生了什么”之外，在提交消息中说明“为什么”（提供有价值的消息）
• 不要只链接到 bugtracker，因为这些以后可能会变得无法访问（“惟有变化才是永恒的。”——Heraclitus，古希腊哲学家）
• 保持一致的风格
  • 首字母大写（除非第一个单词是 openSUSE）😉
  • 使用祈使形式（祈使形式不是粗鲁的表达形式；它详细且清晰，就像本博客的标题一样）
  • 摘要中没有尾随点
  • 限制行长度（一个好的规则是保持字符使用率低；第一行大约 50 个）

对更多细节感兴趣的人，可在 https://cbea.ms/git-commit/ 获得有大量有用的提示。

---

原文：Good Commit Messages Give Devs Meaning, Purpose，作者：Douglas DeMaio