票证/PR 编号应该在提交标头中吗

Question

我看到很多人把票/PR 号放在 git commit header 中。我认为当您阅读

git log

时，它只会增加混乱，因为作为人类，这些数字不会告诉您任何信息。

将数字放入提交消息中（空行之后的任何内容）会更有意义，因为它将保留此提交修复/与该问题相关的记录，并且允许轻松搜索，但会使日志干净且可读。

我试图找到人们为什么这样做的答案？

Answer 1

这是征求意见。我尝试让我的提交消息保持独立，以便人们无需连接到 github 就可以理解（毕竟，如果您需要连接到站点来查看正在发生的情况，那么分布式 SCM 工具有什么用）。然而，github 提供了一些有用的钩子来按数量关闭 bug，因此提交消息中的“closes #42”并不是一个过大的杀伤力，但它应该出现在描述中而不是标题中。

Answer 2

我原则上同意你的观点，提交主题行中的混乱越少越好。但我不会说这些引用对人类来说毫无用处，因为许多工具可以自动将票证 ID 链接到日志概述中相应的票证（通常默认情况下仅显示主题行）。尽管如此，主题行应该提供足够的上下文来揭示提交的内容，而不要求读者点击链接。

对于 GitHub 票证 ID，必须小心，不要将它们放在行的开头，因为它们以

#

开头，它被 git 解释为注释行，因此不会包含在消息中。

我认为从技术上讲，最好的解决方案是将相关的票号作为“元数据”放入提交消息预告片中。如果业界能够就通用约定达成一致，工具也可以支持这一点，但在此之前，我认为人们将继续使用主题行作为票证 ID。

Answer 3

我怀疑答案是因为 Github 默认情况下会在你“压缩并合并”提交时执行此操作。

我在他们的论坛上询问是否有办法禁用这种烦人的行为。