首页 > 解决方案 > Git评论模式?

问题描述

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

有两行,摘要文本将显示 line1_line2 << 两行由空格分隔,然后根据可用空间截断。我发现在第一行之后有一个空格,然后是 CRLF,摘要往往只显示第 1 行,具体取决于我查看的位置。

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

标签: git

解决方案


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

主题行

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


推荐阅读