代码之家  ›  专栏  ›  技术社区  ›  Ido Ran

票据/pr号是否应在提交头中

git
  •  0
  • Ido Ran  · 技术社区  · 6 年前

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

    将数字放在提交消息中(在空白行之后的任何内容)将更加有意义,因为它将保留该提交与该问题相关的记录,并允许进行简单的搜索,但会使日志保持干净和可读性。

    我想找出人们为什么这样做的答案?

    1 回复  |  直到 6 年前
        1
  •  2
  •   Noufal Ibrahim    6 年前

    这是在征求意见。我尽量保持提交消息的自包含性,这样人们就可以不必连接到GitHub(毕竟,如果需要连接到一个站点来查看正在发生的事情,那么分布式SCM工具的用途是什么)。但是,Github提供了一些有用的钩子来按数字关闭bug,因此提交消息中的“closes 42”不是一个过度杀戮,而是应该在描述中而不是头中。