PR 協調員

SIG Docs 的 審批員 負責為倉庫管理拉取請求（pull request），輪班期為一週。

本節介紹 PR 協調員的職責。有關如何提供良好審閱的更多資訊，請參閱審閱更改。

職責

每週一次，作為 PR 協調員的輪班日

• 審閱未處理的拉取請求，確保其質量並符合樣式和內容指南。
  • 先從最小的 PR（size/XS）開始，最後處理最大的（size/XXL）。儘量多審閱 PR。
• 確保 PR 貢獻者已簽署CLA。
  • 使用此指令碼提醒尚未簽署 CLA 的貢獻者簽署。
• 對更改提供反饋，並請求其他 SIG 成員進行技術審閱。
  • 在 PR 中對建議的內容更改提供內聯建議。
  • 如果您需要驗證內容，請在 PR 中留下評論並要求更多詳細資訊。
  • 分配相關的 sig/ 標籤。
  • 如有必要，從檔案 front matter 中的 reviewers: 塊中分配審閱者。
  • 您還可以透過在 PR 中評論 @kubernetes/<sig>-pr-reviews 來標記一個SIG進行審閱。
• 使用 /approve 評論批准 PR 以合併。準備就緒後合併 PR。
  • PR 在合併之前應獲得另一位成員的 /lgtm 評論。
  • 可以接受技術上準確但未滿足樣式指南的內容。在批准更改的同時，開啟一個新問題來解決樣式問題。您通常可以將這些樣式修復問題寫成“good first issue”。
  • 將樣式修復用作“good first issue”是確保提供更多簡單任務以幫助新貢獻者入職的好方法。
• 另外，檢查針對參考文件生成器程式碼的拉取請求，並審閱這些請求（或尋求幫助）。
• 支援問題協調員，以便每天分類和標記傳入的問題。有關 SIG Docs 如何使用元資料的指南，請參閱分類和標記問題。

PR 協調員的實用 GitHub 查詢

以下查詢在協調時很有用。在處理完這些查詢後，剩餘的 PR 審閱列表通常會很小。這些查詢不包括本地化 PR。除最後一個查詢外，所有查詢都針對主分支。

• 無 CLA，不可合併：提醒貢獻者簽署 CLA。如果機器人和人類都提醒過他們，請關閉 PR 並提醒他們簽署 CLA 後可以重新開啟。請勿審閱作者未簽署 CLA 的 PR！
• 需要 LGTM：列出需要成員 LGTM 的 PR。如果 PR 需要技術審閱，請使用機器人建議的審閱者之一。如果內容需要修改，請在內聯新增建議和反饋。
• 已有 LGTM，需要文件批准：列出需要 /approve 評論才能合併的 PR。
• 快速獲勝：列出針對主分支的 PR，沒有明顯障礙。（在處理 PR 時更改 size 標籤中的“XS” [XS, S, M, L, XL, XXL]）。
• 未針對主分支：如果 PR 是針對 dev- 分支的，則表示即將釋出的版本。使用 /assign @<manager's_github-username> 分配文件釋出經理。如果 PR 是針對舊分支的，請幫助作者弄清楚其目標分支是否是最佳分支。

PR 協調員的 Prow 命令

# add English label
/language en

# add squash label to PR if more than one commit
/label tide/merge-method-squash

# retitle a PR via Prow (such as a work-in-progress [WIP] or better detail of PR)
/retitle [WIP] <TITLE>

何時關閉拉取請求

審閱和批准是保持 PR 佇列精簡和最新的工具之一。另一個工具是關閉。

關閉 PR 的情況

• 作者兩週未簽署 CLA。

  作者簽署 CLA 後可以重新開啟 PR。這是確保沒有未經簽名 CLA 的 PR 被合併的低風險方法。

• 作者在 2 周或更長時間內未回覆評論或反饋。

不要害怕關閉拉取請求。貢獻者可以輕鬆地重新開啟並恢復正在進行的工作。通常，關閉通知是促使作者恢復並完成其貢獻的動力。

要關閉拉取請求，請在 PR 中留下 /close 評論。

PR 協調員見習計劃

2021 年末，SIG Docs 推出了 PR 協調員見習計劃。該計劃的目的是幫助新貢獻者理解 PR 協調過程。

成為見習者

• 如果您有興趣作為 PR 協調員見習，請訪問PR 協調員 Wiki 頁面，檢視今年的 PR 協調計劃並進行註冊。

• 其他人可以透過#sig-docs Slack 頻道聯絡，請求在特定的一週內見習已分配的 PR 協調員。請隨時聯絡SIG Docs 聯合主席/負責人。

• 一旦您註冊為 PR 協調員見習，請在Kubernetes Slack上向 PR 協調員介紹自己。