Git - 我应该在每个分支中有不同的自述文件吗？

Question

我刚刚意识到在 Bitbucket 中导航，每个分支中可能有不同的 README，每个 README 都在谈论分支。否则，Bitbucket 会显示每个分支的主 README，这没有多大意义。

这会是个好习惯吗？

Answer 1

README 只是另一个受源代码控制的文件，因此，从 Git 的角度来看，该文件没有发生任何特殊情况。通常，README 应该给出项目的高级概述；如何安装它、它的依赖项、许可证、团队成员列表等。这些信息不太可能在不同分支之间发生变化。出于这个原因，它有意义在所有分支中持续存在，因为即使分支可能用于新功能，项目的高级细节可能保持不变。此外，特性、热修复、错误修复等分支在本质上是相当短暂的，所以一旦它们被 merge 到开发或主控中，它们通常(或至少应该)被删除。所以我真的看不出你需要为每个分支定制一个 README 的理由。

所以我猜答案是否定的，你不应该在每个分支中有不同的 README。只要您遵循合理的分支模型并在必要时使用注释标记发布，您就不需要花费额外的时间为每个分支编写新的 README 内容。