好的提交消息能赋予开发者意义和目标

2022年12月20日 | Douglas DeMaio | CC-BY-SA-3.0

Good Commit Messages Give Devs Meaning, Purpose

为提交信息添加清晰度能显著帮助其他开发者,这篇简短的博客将分享一些编写高质量提交信息的最佳实践,用于 openSUSE 和开源贡献。

提交信息在团队成员之间传递重要信息,由于开源软件是一个大型团队,专注于开放协作,因此在这些信息中传达上下文至关重要。

为什么?

“为什么?”现在对你来说可能很明显,但对其他人来说可能不是,特别是那些尚未参与你的代码的人。精心编写的提交信息能帮助开发者记住之前的提交的各个方面,并帮助未来的开发者理解更改内容以及更改的目的。 

提交信息可能被认为是无结构和不一致的,但只要花一点时间和精力,这些信息就能产生巨大的影响。思考以一种简洁明了的方式编写提交信息;就像一位士官发布命令或指示一样。擦亮你的靴子。 清理厕所。 做俯卧撑。 更具体地说,想象一下父母告诉孩子该做什么以及为什么。擦干净炉子,因为你洒在上面的食用油可能会导致下一个人使用时着火。

以下是一些编写良好提交信息的其他有用的提示。

重要事项

  • 在提交信息中包含“为什么”以及“是什么”(创建一个提供价值的信息)

  • 不要仅仅链接到bug跟踪器,因为这些链接以后可能会变得无法访问(“唯一不变的就是变化” - 古希腊哲学家赫拉克利特)

  • 风格一致性加分

    • 首字母大写(除非第一个词是 openSUSE) :wink:

    • 使用祈使语气(祈使语气不是粗鲁的表达方式;它详细且提供了清晰度,就像这篇博客的标题一样)

    • 摘要中不要使用句号

    • 限制行长度(一个好的规则是保持字符使用量较低;第一行大约 50 个字符)

对于那些对更多细节感兴趣的人,可以在 https://cbea.ms/git-commit/ 上找到大量有用的提示。

分享此帖子