【问题标题】:Git comment patterns? [duplicate]Git评论模式? [复制]
【发布时间】:2019-06-06 15:44:55
【问题描述】:

我觉得问这个很愚蠢,但我们开始吧:在执行 git commit 时,我们可以在评论中使用一行或多行。我的目标是仅将报告中的第一行视为摘要,并提供仅在查看提交详细信息时才能看到的更多详细信息。例如,当您访问 GitHub 并查看源文件文件夹时,它会显示文件名和上次提交的摘要。所以你可以看到 N 天前的更新是关于 'foo' 的——它没有显示每个文件最后一次提交的完整评论。

有两行,摘要文本将显示 line1_line2

我要问的是,是否有我们应该遵循的特定模式来确保摘要行只包含我们想要的内容,而不是 line1_line2 的某些截断版本。 cmets 中还有其他被普遍接受的语法吗?例如,#00 语法可能/应该链接到与 repo 相关的问题跟踪器,但这取决于平台。而且我认为评论中没有标记标准,我认为它必须是纯文本。我说的是普遍接受的模式。谢谢。

【问题讨论】:

  • 这确实是重复的,我无法表达一个像样的查询来找到其他答案。谢谢@phd。

标签: git


【解决方案1】:

摘要是提交消息的第一行,直到 CRLF。在第一行之后留一个空行,你应该没问题。例如:

主题行

提交信息的其余部分。由于它前面有一个空行,因此它不会作为摘要的一部分显示。

【讨论】:

  • 您提供了一个很好的答案,但由于这是一个重复的问题,我需要将其标记为这样。其他地方的 50/72 注释更好地解释了主题和细节的格式。我看到另一个注释,确认第一行末尾的空格是故意的 EOL 信号。但是你在这里关于简单地使用空 line2 的建议是我遵循的一种模式,但你已经确认这是一个很好的模式。谢谢。
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2020-05-04
  • 1970-01-01
  • 2017-11-27
  • 1970-01-01
  • 1970-01-01
  • 2012-09-17
相关资源
最近更新 更多