在多个github存储库之间共享CONTRIBUTING.md文件

时间:2015-08-30 11:47:08

标签: git github automation collaboration

问题:我们在https://github.com/whatwg github组织中有多个github repos,并希望在每个repo中的CONTRIBUTING.md文件中都有相同的内容 - 但是我们不想手动维护/修改文件分开。相反,我们希望自动化一种方法来保持它们的同步。

所以基本上,我想我想要一个“主人”CONTRIBUTING.md,每个仓库中的副本(半)自动与主人CONTRIBUTING.md保持同步(不知何故)

所以我可以想象我们可以将主人CONTRIBUTING.md保留在一个回购中,并且可能为该回购设置client-side hook,这样每次有人推动改变那个主人,变化也被推到了所有其他的回购?或者也许我可以将其设置为通过Travis CI自动推送到另一个repos?

或者可能有一些比使用客户端钩子或Travis CI更好的方法吗?

无论如何,就所有这些背后的“原因”而言,原因是,我们希望始终对每个回购使用相同的贡献者指南,同时,我们希望获得github-specific benefits that come from having a CONTRIBUTING.md file

1 个答案:

答案 0 :(得分:0)

GitHub's docs中所述:

<块引用>

您可以将默认社区健康文件添加到组织或用户帐户拥有的名为 .github 的公共存储库的根目录中。

因此,如果您想在整个组织中共享 CONTRIBUTING.md 文件,一种方法是在组织中创建一个名为 .github 的公共存储库并将 CONTRIBUTING.md 文件放入在里面。例如,查看 Democritus Project's .github repo

附言- 您可以在组织的 CONTRIBUTING.md 存储库中存储多个 .github 文件;有一个受支持的文件列表 here,我认为您也可以在此存储库中包含 github actions