GitHub 开源文档:人人可参与贡献,双仓库同步更新
【导语:GitHub 的文档是开源的,公司内外人员均可参与贡献。其文档有公开和私有两个仓库,会频繁同步内容变更。本文详细介绍了贡献方式、初次贡献指南及许可协议等内容。】
GitHub 的文档是开源的,这为公司内外的任何人提供了参与贡献的机会。若想查看完整的贡献指南,可访问贡献指南页面。
GitHub 文档有两个仓库,公开的 `github/docs` 接受外部贡献,私有 `github/docs-internal` 供 GitHub 员工贡献使用。这两个仓库会频繁同步,一个仓库的内容变更会反映到另一个仓库。
不过,`docs` 对接受的贡献类型有所限制,仅接受对内容文件(`/content` 中的 `.md` 文件以及 `/data` 部分特定内容)的贡献,基础设施文件、工作流和网站构建代码不接受外部修改。
对于初次进行开源贡献的人,GitHub 提供了一些帮助资源,如 在 GitHub 上寻找开源贡献途径、设置 Git、GitHub 流程、使用拉取请求进行协作 等。
本项目采用双重许可协议,知识共享署名 4.0 许可协议适用于 `assets`、`content` 和 `data` 文件夹中的文档和内容;MIT 许可协议适用于代码。
编辑观点:GitHub 开源文档的模式极大地促进了知识的共享和协作,双仓库的设置既保证了外部参与,又保护了内部工作流程,双重许可协议也保障了各方权益。
