角色和職責

任何人都可以為 Kubernetes 做貢獻。隨著您對 SIG Docs 的貢獻不斷增加,您可以在社群中申請不同級別的成員資格。這些角色使您能夠在社群中承擔更多責任。每個角色都需要更多的時間和承諾。這些角色是:

  • 任何人:Kubernetes 文件的常規貢獻者
  • 成員:可以分配和分類問題,並對拉取請求提供無約束力的評審
  • 審閱者:可以主導文件拉取請求的評審,並能為變更的質量作擔保
  • 批准者:可以主導文件評審和合並變更

任何人

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

任何人都可以

簽署 CLA 後,任何人也可以

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

有關更多資訊,請參閱 貢獻新內容

成員

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

成員可以

  • 任何人列出的所有操作

  • 使用 /lgtm 命令為拉取請求新增 LGTM(看起來不錯)標籤

  • 使用 /hold 命令阻止拉取請求的合併

  • 使用 /assign 命令將審閱者分配給拉取請求

  • 對拉取請求提供無約束力的反饋

  • 使用自動化來分類和歸檔問題

  • 記錄新功能

成為成員

在提交至少 5 個實質性的拉取請求並滿足其他 要求

  1. 找到兩名 審閱者批准者擔保您的成員資格。

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

  2. kubernetes/org 倉庫中開啟一個 GitHub 問題。使用 **Organization Membership Request** 問題模板。

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

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

    • 使用 Slack 或電子郵件將問題連結傳送給他們。

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

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

  4. 接受您郵箱賬戶中 Kubernetes GitHub 組織的邀請。

審閱者

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

審閱者可以

  • 執行 任何人成員下所列的所有操作

  • 評審拉取請求並提供具有約束力的反饋

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

  • 改進程式碼註釋

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

將審閱者分配給拉取請求

自動化會將審閱者分配給所有拉取請求。您可以透過評論請求特定人員的評審:/assign [@_github_handle]

如果分配的審閱者沒有在 PR 上發表評論,則可以由另一位審閱者接手。您也可以根據需要分配技術審閱者。

使用 /lgtm

LGTM 代表“看起來不錯”(Looks good to me),表明一個拉取請求在技術上是準確的,並且可以合併。所有 PR 都需要來自審閱者的 /lgtm 評論和來自批准者的 /approve 評論才能合併。

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

成為審閱者

當您滿足 要求時,您可以成為 SIG Docs 審閱者。其他 SIG 中的審閱者必須單獨申請 SIG Docs 中的審閱者身份。

申請方法

  1. 開啟一個拉取請求,將您的 GitHub 使用者名稱新增到 kubernetes/website 倉庫的 OWNERS_ALIASES 檔案中的一個部分。

  2. 將 PR 分配給一個或多個 SIG Docs 批准者(使用者名稱列在 sig-docs-{language}-owners 下)。

如果獲得批准,SIG Docs 負責人會將您新增到相應的 GitHub 團隊。新增後,K8s-ci-robot 會為您分配身份,並在新的拉取請求中建議您為審閱者。

批准者

批准者評審並批准拉取請求以進行合併。批准者是 @kubernetes/sig-docs-{language}-owners GitHub 團隊的成員。

批准者可以執行以下操作

  • 任何人成員審閱者 下所列的所有操作
  • 透過批准和合並拉取請求(使用 /approve 命令)來發布貢獻者內容
  • 提議改進風格指南
  • 提議改進文件測試
  • 提議改進 Kubernetes 網站或其他工具

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

批准拉取請求

批准者和 SIG Docs 負責人是唯一可以合併拉取請求到網站倉庫的人。這附帶一定的責任。

  • 批准者可以使用 /approve 命令,該命令會將 PR 合併到倉庫中。

  • 確保擬議的更改符合 文件內容指南

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

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

    Netlify tests must pass before approving
  • 訪問 PR 的 Netlify 頁面預覽,以確保在批准之前一切看起來都很不錯。

  • 參與 PR 整理器輪換計劃,按周進行輪換。SIG Docs 希望所有批准者都能參與此輪換。有關更多詳細資訊,請參閱 PR 整理器

成為批准者

當您滿足 要求時,您可以成為 SIG Docs 批准者。其他 SIG 中的批准者必須單獨申請 SIG Docs 中的批准者身份。

申請方法

  1. 開啟一個拉取請求,將您自己新增到 kubernetes/website 倉庫的 OWNERS_ALIASES 檔案中的一個部分。

  2. 將 PR 分配給一個或多個當前的 SIG Docs 批准者。

如果獲得批准,SIG Docs 負責人會將您新增到相應的 GitHub 團隊。新增後,@k8s-ci-robot 會為您分配身份,並在新的拉取請求中建議您為審閱者。

下一步

  • 閱讀關於 PR 整理的內容,這是一個所有批准者輪流承擔的角色。
最後修改於 2022 年 9 月 28 日太平洋標準時間上午 12:20: Reword in sig-docs contributor roles (35621ef457)