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

Git - should I have a different README in each branch?

我刚刚意识到在 Bitbucket 中导航,每个分支中可能有不同的自述文件,每个都在谈论分支。否则,Bitbucket 会显示每个分支的主 README,意义不大。

这是个好习惯吗?

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

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

不,这不是一个好的做法。

虽然不同的分支确实有不同的目的,并且对每个特定分支的描述可能有用,但这不是 README 文件的目的。 README 文件中包含的信息旨在描述整个项目,而不是单个方面或分支。

通常 README 文件包含 概要、动机、安装信息、代码示例、测试、API 参考、贡献者部分和许可证信息。 这每个分支的信息通常不是唯一的,因为它侧重于整个项目。

换句话说,README 文件用于通知其他人(在大多数情况下是其他开发人员)项目是关于什么的,它的目的是什么,你如何 运行 它和其他类似的元细节。