票证/公关号应在提交标头中

Question

我看到很多人在git commit标头中放置了工单/ PR号。我认为这只会在您阅读git log时增加混乱，因为作为人类，这些数字不会告诉您任何东西。

将数字放在提交消息中（在空行之后的任何内容）将更加有意义，因为它将保留该提交已解决/与该问题相关的记录，并允许轻松搜索，但将日志保持整洁和可读。

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

Answer 1

这是征求意见。我尝试使提交消息保持独立，以便对人们有意义，而不必连接到github（毕竟，如果您需要连接到站点以查看发生了什么，则可以使用分布式SCM工具）。但是，github提供了一些有用的钩子来按数字关闭错误，因此提交消息中的“ closes＃42”并不是一个过分的杀伤力，而应该在描述中而不是标头中。

Answer 2

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

对于 GitHub 票证 ID，必须小心，不要将它们放在行的开头，因为它们以 # 开头，它被 git 解释为注释行，因此不会被包含在内在消息中。

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