票证/PR 编号是否应在提交标头中



我看到很多人把票证/PR号码放在git提交头中。我认为当你阅读git log时,它只会增加混乱,因为作为人类,这些数字并不能告诉你任何事情。

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

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

这是在征求意见。我尝试使我的提交消息自包含,以便人们无需连接到 github 即可有意义(毕竟,如果您需要连接到站点以查看正在发生的事情,分布式 SCM 工具有什么用(。但是,github 提供了一些有用的钩子来按数字关闭错误,因此提交消息中的"关闭 #42"并不是矫枉过正,而是应该在描述中而不是标头中。

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

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

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

最新更新