如何在遠程存儲庫中記錄分支？

我想爲分支上正在完成的工作添加一個簡短的說明/基本原理。只有一兩句話，但遠遠超過可以通過分行名稱進行溝通。不幸的是，我一直無法找到一個明確的方式來完成這一點。如何在遠程存儲庫中記錄分支？

該git branch --edit-description命令將似乎理想，除了，因爲它存儲在repo配置，它不能被推送。如果其他人無法閱讀，那麼這些文檔就沒有太大用處。想到兩種選擇，但都存在語義問題。

第一個是將文檔存儲在存儲庫內容中。我覺得這個選項不吸引人，因爲它「污染」了儲存庫內容，並且因爲它有副作用 - 特別是在合併時。

另一種是使用git commit --allow-empty來創建一個沒有變化的提交。這仍然違反了提交的語義，但至少將元數據保存在存儲庫中。

我目前傾向於使用empty-commit技術，但是還有其他的選擇嗎？我忽略的其他問題？

完成此操作的典型方法是什麼？

2014-10-05 Ben Blank

不是一個只有git的或完整的解決方案，但是如果您使用某種形式的售票系統跟蹤所有工作，則分行名稱中的票證ID可以提供幫助。就我個人而言，我甚至不知道git分支可能有描述 - 我很好奇，即使您能夠遠程獲得它，也有多少人會看到它。 – 2014-10-05 19:55:42

我不知道這是一個選擇的更好，但...

假設這是不會被重建基礎的一個分支，那麼你可以用類似的名稱創建一個註釋標籤分支在初始分支點，然後使用標籤的提交消息來描述分支。

所以不是

git checkout -b my_feature SOME_START_POINT

你會

git tag -m "Startpoint of the my_feature branch which is for ...." MY_FEATURE SOME_START_POINT 
git branch my_feature MY_FEATURE

或者像my_feature_start_point一些其他的命名方案等

的信息不會與分支本身有關，但會以人類可以根據需要找出的方式進行關聯。

2014-10-05 19:57:17

回答