與 GitHub 協作

3 分鐘閱讀時間

Istio 文件遵循標準的 GitHub 協作流程來處理 Pull Requests (PR)。這種成熟的協作模式有助於開源專案管理以下類型的貢獻：

新增檔案到儲存庫。
編輯現有檔案。
審閱新增或修改的檔案。
管理多個發佈或開發分支。

貢獻指南假設您可以完成以下任務：

Fork Istio 文件儲存庫。
為您的變更建立分支。
將提交新增到該分支。
開啟 PR 以分享您的貢獻。

開始之前

若要貢獻 Istio 文件，您需要：

建立一個 GitHub 帳戶。
簽署貢獻者授權協議。
在您的撰寫系統上安裝 Docker 以預覽和測試您的變更。

Istio 文件是在 Apache 2.0 許可下發佈的。

執行快速編輯

任何擁有 GitHub 帳戶並簽署 CLA 的人都可以對 Istio 網站上的任何頁面進行快速編輯。流程非常簡單：

造訪您要編輯的頁面。
在 URL 的開頭新增 preliminary。例如，若要編輯 https://istio.dev.org.tw/about，新的 URL 應該是 https://preliminary.istio.io/about
點擊右下角的鉛筆圖示。
在 GitHub UI 上執行您的編輯。
提交包含您變更的 Pull Request。

請參閱我們的指南，瞭解如何貢獻新內容或審閱內容，以瞭解更多關於提交更實質性變更的資訊。

分支策略

活躍的內容開發會在 istio/istio.io 儲存庫的 master 分支上進行。在 Istio 發佈的當天，我們會為該發佈建立 master 的發佈分支。以下按鈕會將您帶到 GitHub 上的儲存庫：

瀏覽本網站的原始碼

Istio 文件儲存庫使用多個分支來發佈所有 Istio 發佈的文件。每個 Istio 發佈都有一個對應的文件分支。例如，有稱為 release-1.0、release-1.1、release-1.2 等的分支。這些分支是在對應的發佈當天建立的。若要檢視特定發佈的文件，請參閱封存頁面。

此分支策略允許我們提供以下 Istio 線上資源：

公開網站顯示來自目前發佈分支的內容。
位於 https://preliminary.istio.io 的初步網站顯示來自 master 分支的內容。
封存網站顯示來自所有先前發佈分支的內容。

根據分支的運作方式，如果您將變更提交到 master 分支，該變更在下一個主要的 Istio 發佈之前不會出現在 istio.io 上。如果您的文件變更與目前的 Istio 發佈相關，那麼最好將您的變更也應用於目前的發佈分支。您可以透過使用文件 PR 上的特殊 cherry-pick 標籤輕鬆自動完成此操作。例如，如果您在對 master 分支的 PR 中引入了更正，您可以應用 cherrypick/release-1.4 標籤，以便將此變更合併到 release-1.4 分支。

當您的初始 PR 合併時，自動化會在發佈分支中建立一個新的 PR，其中包含您的變更。

在極少數情況下，自動 cherry pick 無法運作。當這種情況發生時，自動化會在原始 PR 中留下一個註記，指出它失敗了。當這種情況發生時，您必須手動建立 cherry pick 並處理阻止該流程自動運作的合併問題。

請注意，我們只會將變更 cherry pick 到目前的發佈分支，而永遠不會 cherry pick 到舊的分支。舊的分支被認為已封存，通常不再接收任何變更。