Git - 我应该在每个分支中有不同的README吗？

Question

我刚刚在Bitbucket中发现一个功能，每个分支可以有不同的README文件，以便说明该分支的内容。否则，Bitbucket会在每个分支上显示主README文件，这没有太多意义。这是否是一个好的做法？

- Julen

---

有时我会在我的dev分支的README中概述建议的功能/更改，而我会从我的master README中省略它们。 - alexw

嗯，即使我同意下面的答案，我还是觉得你的想法很有趣。 - Julen

Answer 1

README只是另一个源代码控制下的文件，因此，从Git的角度来看，该文件没有任何特殊之处。通常，README应该提供项目的高级概述;如何安装它，其依赖项，许可证，团队成员列表等。这些信息不太可能从分支到分支发生变化。出于这个原因，让它在所有分支中保持一致是有道理的，因为即使分支是为一个新功能而创建的，项目的高级细节也可能保持不变。此外，像功能、热修复、错误修复等分支本质上是短暂的，所以一旦它们合并到开发或主分支中，它们通常会被删除(或者至少应该被删除)。所以我真的看不出你需要每个分支都有一个自定义 README 的原因。

所以我的回答是"不需要"，如果你遵循合理的分支模型，并在必要时使用标签发布说明，你就不需要额外的时间编写每个分支的新README内容。

- Peter Foti

Answer 2

不，这不是一个好的做法。虽然不同的分支有不同的目的和描述，每个特定的描述可能是有用的，但这不是README文件的目的。README文件中包含的信息旨在描述整个项目，而不是单个方面或分支。通常，README文件包含概要、动机、安装信息、代码示例、测试、API参考、贡献者部分和许可证信息。这些信息通常对于每个分支来说并不唯一，因为它关注的是整个项目。换句话说，README文件用于向其他人（大多数情况下是其他开发人员）介绍项目的内容、目的、如何运行以及其他类似的元数据。

- Ivaylo Toskov