如何註釋一個git倉庫？

Question

我有一個git倉庫，在每次提交中，已經完成了幾件事情，因此，我的單行提交消息不足以完全解釋發生了什麼。

我希望能夠稍後再回到這些事情上，供我自己參考，並且能夠以某種形式發佈它們。我知道，如果我要將我的本地存儲庫推送到git託管提供商（如github或bitbucket），我可以通過他們的Web界面查看每個提交和diff-patch，併爲其添加註釋並添加到個別行中。我將把它們稱爲差異註釋。

這樣做的缺點是git託管提供者擁有所有diff註釋數據，並且我的本地git存儲庫將不包含它們。

• 有沒有辦法從git託管服務提供商「導出」或「下載」這些差異註釋？
• 是否有一個git工具或插件，允許我在我的本地存儲庫中創建差異註釋（無需推送到git託管提供商）？

Answer 1

我想混帳提供你所需要的，不知道您的情況多麼複雜，但我的建議是

小提交

以下你說「在每次提交，幾件事情已經完成了，因此，我的單行提交信息不足以完全解釋正在發生的事情。「。那麼，有些人可能會說，但我會保持提交儘可能小和簡單，所以他們可以在一行解釋。

即使對於大的功能，您通常可以將它們分成較小的變化。我確實在提交補丁的地方提交，或者在不必編碼的情況下公開API。例如，如果您使用的是git bisect，小提交很好地檢測未來的錯誤。

冗長的描述

我不知道，如果我說的東西完全瑣碎，道歉，如果我是，但你並不需要做一個班輪提交信息每次。你總是做commit -am <message>。你知道，如果你輸入的提交沒有-m，你的默認編輯器將打開，然後你可以編寫類型的第一行摘要，如果你願意的話跟着聖經。

即將帶回審查

是，GitHub的將是巨大的，如果你想瀏覽源，但如果你想回去的時間，並檢查您的意見/上一個指定的提交，你只需要批註例如通過git log搜索提交，然後選擇提交ID，則可以執行git show <commitId>。

這將顯示所有的變化與旁邊所有的意見。