角色和職責

任何人都可以為 Kubernetes 做出貢獻。隨著您對 SIG Docs 的貢獻增加,您可以申請社群中不同層級的成員資格。這些角色讓您可以在社群內承擔更多責任。每個角色都需要更多時間和投入。角色如下:

  • 任何人:Kubernetes 文件的定期貢獻者
  • 成員:可以指派問題、對問題進行分類,並對提取請求提供非約束性審閱
  • 審閱者:可以主導文件提取請求的審閱,並為變更的品質背書
  • 核准者:可以主導文件審閱並合併變更

任何人

任何擁有 GitHub 帳戶的人都可以為 Kubernetes 做出貢獻。SIG Docs 歡迎所有新的貢獻者!

任何人都可以

簽署 CLA 後,任何人也可以

  • 開啟提取請求以改進現有內容、新增內容,或撰寫部落格文章或案例研究
  • 建立圖表、圖形資產,以及可嵌入的螢幕錄影和影片

如需更多資訊,請參閱 貢獻新內容

成員

成員是指已向 kubernetes/website 提交多個提取請求的人。成員是 Kubernetes GitHub 組織 的一部分。

成員可以

  • 執行 任何人 下列出的所有事項

  • 使用 /lgtm 註解將 LGTM(Looks Good To Me,看起來不錯)標籤新增至提取請求

  • 使用 /hold 註解阻止合併提取請求

  • 使用 /assign 註解指派審閱者給提取請求

  • 對提取請求提供非約束性審閱

  • 使用自動化來分類和歸類 Issue

  • 文件化新功能

成為成員

在提交至少 5 個實質的 Pull Request 並符合其他 要求

  1. 尋找兩位審閱者核准者擔保您的成員資格。

    Slack 上的 #sig-docs 頻道SIG Docs 郵件列表中請求擔保。

  2. kubernetes/org 儲存庫中開啟一個 GitHub issue。使用組織成員資格請求 issue 模板。

  3. 讓您的擔保人知道 GitHub issue。您可以選擇:

    • 在 issue 中提及他們的 GitHub 使用者名稱 (@<GitHub-username>)

    • 使用 Slack 或電子郵件發送 issue 連結給他們。

      擔保人將以 +1 投票批准您的請求。一旦您的擔保人批准請求,Kubernetes GitHub 管理員會將您新增為成員。恭喜!

      如果您的成員資格請求未被接受,您將收到回饋。在處理回饋後,請再次申請。

  4. 在您的電子郵件帳戶中接受加入 Kubernetes GitHub 組織的邀請。

審閱者

審閱者負責審閱開啟的 pull request。與成員回饋不同,PR 作者必須處理審閱者的回饋。審閱者是 @kubernetes/sig-docs-{language}-reviews GitHub 團隊的成員。

審閱者可以

  • 執行在 任何人成員 下列出的所有事項

  • 審閱 pull request 並提供具約束力的回饋

  • 編輯程式碼中面向使用者的字串

  • 改善程式碼註解

您可以成為 SIG Docs 審閱者,或是特定主題領域文件中文件的審閱者。

指派審閱者到 pull request

自動化會將審閱者指派給所有 pull request。您可以透過評論請求特定人員審閱:/assign [@_github_handle]

如果被指派的審閱者沒有評論 PR,另一位審閱者可以介入。您也可以根據需要指派技術審閱者。

使用 /lgtm

LGTM 代表 "Looks good to me",表示 pull request 在技術上是準確且準備好合併的。所有 PR 都需要來自審閱者的 /lgtm 評論和來自核准者的 /approve 評論才能合併。

來自審閱者的 /lgtm 評論具有約束力,並觸發自動化以新增 lgtm 標籤。

成為審閱者

當您符合要求時,您可以成為 SIG Docs 審閱者。其他 SIG 的審閱者必須另外申請 SIG Docs 中的審閱者身份。

如何申請

  1. 開啟一個 pull request,將您的 GitHub 使用者名稱新增到 kubernetes/website 儲存庫中 OWNERS_ALIASES 檔案的某個區段。

  2. 將 PR 指派給一位或多位 SIG-Docs 核准者(使用者名稱列在 sig-docs-{language}-owners 下)。

如果獲得批准,SIG Docs 負責人會將您新增到適當的 GitHub 團隊。新增完成後,K8s-ci-robot 會在新 pull request 上指派並建議您擔任審閱者。

核准者

核准者審閱並核准要合併的 pull request。核准者是 @kubernetes/sig-docs-{language}-owners GitHub 團隊的成員。

核准者可以執行以下操作

  • 任何人成員審閱者 下列出的所有事項
  • 透過使用 /approve 評論核准和合併 pull request 來發布貢獻者內容
  • 提議改進樣式指南
  • 提議改進文件測試
  • 提議改進 Kubernetes 網站或其他工具

如果 PR 已經有 /lgtm,或者如果核准者也評論 /lgtm,則 PR 會自動合併。SIG Docs 核准者僅應對不需要額外技術審閱的變更留下 /lgtm

核准 pull request

核准者和 SIG Docs 負責人是唯一可以將 pull request 合併到網站儲存庫的人員。這伴隨著某些責任。

  • 核准者可以使用 /approve 命令,這會將 PR 合併到儲存庫中。

  • 確保提議的變更符合文件內容指南

    如果您有任何疑問,或者您對某些事情不確定,請隨時要求額外審閱。

  • 在您 /approve PR 之前,請驗證 Netlify 測試是否通過。

    Netlify tests must pass before approving
  • 訪問 PR 的 Netlify 頁面預覽,以確保在核准之前看起來良好。

  • 參與 PR Wrangler 輪值表的每週輪值。SIG Docs 期望所有核准者都參與此輪值。有關更多詳細資訊,請參閱 PR wranglers

成為核准者

當您符合要求時,您可以成為 SIG Docs 核准者。其他 SIG 的核准者必須另外申請 SIG Docs 中的核准者身份。

如何申請

  1. 開啟一個 pull request,將您自己新增到 kubernetes/website 儲存庫中 OWNERS_ALIASES 檔案的某個區段。

  2. 將 PR 指派給一位或多位現任 SIG Docs 核准者。

如果獲得批准,SIG Docs 負責人會將您新增到適當的 GitHub 團隊。新增完成後,@k8s-ci-robot 會在新 pull request 上指派並建議您擔任審閱者。

接下來

  • 閱讀關於 PR 管理,這是所有核准者輪流擔任的角色。
最後修改時間:2022 年 9 月 28 日下午 12:20 PST:Reword in sig-docs contributor roles (35621ef457)