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

Question

我刚刚意识到在Bitbucket中导航可能在每个分支中都有不同的README,每个分支都在讨论分支.另外,Bitbucket显示每个分支的主README,它没有多少意义.

这是一个好习惯吗？

Answer 1

这README只是源代码控制下的另一个文件,因此,从Git角度来看,该文件没有什么特别的事情发生.通常,README应该对项目进行高级概述; 如何安装它,它的依赖项,许可证,团队成员列表等.这些信息不太可能从一个分支到另一个分支.出于这个原因,它在所有分支中持续存在是有道理的,因为即使分支可能用于新功能,项目的高级细节也可能保持不变.此外,功能,热修复,错误修复等分支本质上是短暂的,因此一旦它们合并到开发或掌握,它们通常(或至少应该)被删除.因此,我无法确定您需要README为每个分支设置自定义的原因.

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

Answer 2

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

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

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

换句话说，README文件用于告知其他人（在大多数情况下是其他开发人员）该项目的内容、其目的是什么、如何运行它以及其他类似的元详细信息。