与 GitHub 协作

3 分钟阅读

Istio 文档遵循标准的 GitHub 协作流程用于拉取请求 (PR)。这种完善的协作模型帮助开源项目管理以下类型的贡献

添加新文件到存储库中。
编辑现有文件。
审查已添加或修改的文件。
管理多个发布或开发分支。

贡献指南假定您可以完成以下任务

派生 Istio 文档存储库。
为您的更改创建一个分支。
向该分支添加提交。
打开 PR 以分享您的贡献。

开始之前

要为 Istio 文档做出贡献，您需要

创建一个 GitHub 帐户。
签署贡献者许可协议。
在您的创作系统上安装 Docker 以预览和测试您的更改。

Istio 文档是在 Apache 2.0 许可下发布的。

进行快速编辑

任何拥有 GitHub 帐户并签署了 CLA 的人都可以对 Istio 网站上的任何页面进行快速编辑。这个过程非常简单。

访问您想要编辑的页面。
在 URL 开头添加 preliminary。例如，要编辑 https://istio.ac.cn/about，新 URL 应为 https://preliminary.istio.io/about
单击右下角的铅笔图标。
在 GitHub UI 上执行您的编辑。
提交包含您更改的 Pull Request。

请参阅我们的指南，了解如何贡献新内容或审查内容，以了解更多关于提交更实质性更改的信息。

分支策略

活跃的内容开发使用 istio/istio.io 存储库的主分支进行。在 Istio 发布当天，我们会为此版本创建一个主分支的发布分支。以下按钮将带您前往 GitHub 上的存储库

浏览此站点的源代码

Istio 文档存储库使用多个分支来发布所有 Istio 版本的文档。每个 Istio 版本都有一个相应的文档分支。例如，存在名为 release-1.0、release-1.1、release-1.2 等等的分支。这些分支是在相应的版本发布当天创建的。要查看特定版本的文档，请参阅存档页面。

这种分支策略使我们能够提供以下 Istio 在线资源

公共网站显示当前发布分支的内容。
https://preliminary.istio.io 上的预发布站点显示主分支的内容。
存档站点显示所有先前发布分支的内容。

鉴于分支的工作原理，如果您将更改提交到主分支，则该更改在下一个主要 Istio 版本发布之前不会出现在 istio.io 上。如果您的文档更改与当前 Istio 版本相关，那么可能值得将您的更改也应用于当前发布分支。您可以使用文档 PR 上的特殊 cherry-pick 标签轻松自动地完成此操作。例如，如果您在 PR 中为主分支引入了一个更正，则可以应用 cherrypick/release-1.4 标签以将此更改合并到 release-1.4 分支。

当您的初始 PR 被合并时，自动化会创建一个包含您更改的新 PR 在发布分支中。

在极少数情况下，自动 cherry-pick 无法正常工作。在这种情况下，自动化会在原始 PR 中留下一个说明其失败的注释。在这种情况下，您必须手动创建 cherry-pick 并处理阻止该过程自动执行的合并问题。

请注意，我们只将更改 cherry-pick 到当前发布分支，绝不 cherry-pick 到旧分支。旧分支被认为已存档，通常不再接收任何更改。