Git - 我應該在每個分支中有不同的自述文件嗎？

Question

我剛剛意識到在Bitbucket中導航可能在每個分支中都有不同的README，每個分支都在討論分支。 另外，Bitbucket顯示每個分支的主README，它沒有多少意義。

這是一個好習慣嗎？

Answer 1

README只是源代碼控制下的另一個文件，因此，從Git角度來看，該文件沒有什么特別的事情發生。 通常， README應該給出項目的高級概述; 如何安裝它，它的依賴項，許可證，團隊成員列表等。這些信息不太可能從一個分支到另一個分支。 出於這個原因，它在所有分支中持續存在是有道理的 ，因為即使分支可能用於新功能，項目的高級細節也可能保持不變。 此外，功能，熱修復，錯誤修復等分支本質上是短暫的，所以一旦它們合並到開發或掌握，它們通常（或至少應該）被刪除。 因此，我無法確定您需要為每個分支設置自定義README的原因。

所以我猜答案是“不”，你不應該在每個分支中有不同的README 。 只要您遵循合理的分支模型並在必要時標記發布帶有注釋，您就不需要花費額外的時間為每個分支編寫新的README內容。

Answer 2

不，這不是一個好習慣。

雖然不同的分支確實具有不同的目的，並且每個特定的分支的描述可能是有用的，但這不是README文件的目的。 README文件中包含的信息旨在描述整個項目，而不是單個方面或分支。

通常， README文件包含概要，動機，安裝信息，代碼示例，測試，API參考，貢獻者部分和許可證信息。 對於每個分支，此信息通常不是唯一的，因為它側重於整個項目。

換句話說， README文件用於通知其他人（在大多數情況下是其他開發人員）項目的內容，目的是什么，如何運行它以及其他類似的元數據。