git - 如何注释 git 存储库？

Question

我有一个 git 存储库，在每次提交中，都完成了几件事，因此，我的单行提交消息不足以完全解释发生了什么。

我希望以后能回过头来看这些东西，供自己引用，也能以某种形式发表。我知道如果我要将我的本地存储库推送到 git 托管服务提供商，例如 github或 bitbucket ，我可以通过他们的网络界面查看每个提交和差异补丁，并向它们添加评论，也可以在单独的行上添加评论。我将这些称为差异注释。

这样做的缺点是 git 托管提供商保存所有差异注释数据，而我的本地 git 存储库将不包含它们。

• 有没有办法从 git 托管服务提供商“导出”或“下载”这些差异注释？
• 是否有 git 工具或插件允许我在本地存储库中创建差异注释(无需推送到 git 托管服务提供商)？

Answer 1

我认为 Git 提供了你需要的东西，不确定你的场景有多复杂，但我的建议如下:

小提交

您说“在每次提交中，已经完成了几件事，因此，我的单行提交消息不足以完全解释正在发生的事情。”。好吧，有些人可能会不这么认为，但我会保持提交尽可能小和简单，以便它们可以在一行中解释。

即使对于大功能，您通常也可以将它们分成较小的更改。我确实在我只是修复填充的地方提交，或者在不需要编码的情况下公开 API。小提交有利于将来检测错误，例如，如果您使用 git bisect .

冗长的描述

我不确定我是否在说一些完全微不足道的事情，如果我是的话，我深表歉意，但你不需要每次都做一行提交消息。你总是做commit -am <message> ？你知道如果你在没有 -m 的情况下键入 commit ，您的默认编辑器将打开？然后，如果愿意，您可以输入第一行摘要，然后输入圣经。

回来复习

是的，如果您想浏览源代码，GitHub 会很棒，但如果您想回到过去并检查您对给定提交的评论/注释，您只需要通过 git log 搜索提交例如，然后选择提交 ID，您可以执行 git show <commitId> .

这将向您显示所有更改以及您的所有评论。