PR 管理員

SIG Docs 核准者 輪值一週 管理儲存庫的提取請求。

本節涵蓋 PR 管理員的職責。如需良好審閱的更多資訊，請參閱審閱變更。

職責

作為 PR 管理員一週輪值中的每一天

• 審閱 開放提取請求 的品質，並確認是否符合樣式與內容指南。
  • 從最小的 PR (size/XS) 開始，以最大的 (size/XXL) 結束。盡可能審閱更多的 PR。
• 確認 PR 貢獻者是否簽署 CLA。
  • 使用 此 腳本提醒尚未簽署 CLA 的貢獻者簽署。
• 針對變更提供意見回饋，並要求其他 SIG 成員進行技術審閱。
  • 針對建議的內容變更在 PR 上提供內嵌建議。
  • 如果您需要驗證內容，請在 PR 上評論並要求更多詳細資訊。
  • 指派相關的 sig/ 標籤。
  • 如果需要，從檔案前端 matter 中的 reviewers: 區塊指派審閱者。
  • 您也可以透過在 PR 上評論 @kubernetes/<sig>-pr-reviews 來標記 SIG 進行審閱。
• 使用 /approve 評論來核准 PR 以進行合併。準備就緒時合併 PR。
  • PR 在合併前應從另一位成員獲得 /lgtm 評論。
  • 考慮接受技術上準確但不符合樣式指南的內容。當您核准變更時，開啟一個新 issue 以解決樣式問題。您通常可以將這些樣式修正 issue 寫成好的首個 issue。
  • 將樣式修正作為好的首個 issue 是一個確保提供更簡單任務的好方法，以協助新貢獻者入門。
• 同時檢查針對 reference docs generator 程式碼的提取請求，並審閱這些請求 (或引入協助)。
• 支援 issue 管理員 每天分類與標記收到的 issue。請參閱 分類與分類 issue 以取得 SIG Docs 如何使用中繼資料的指南。

適用於管理員的實用 GitHub 查詢

以下查詢在管理時很有幫助。在完成這些查詢後，剩餘要審閱的 PR 清單通常很小。這些查詢排除本地化 PR。除了最後一個查詢外，所有查詢都針對 main 分支。

• 未簽署 CLA，不符合合併資格：提醒貢獻者簽署 CLA。如果機器人與人工都已提醒他們，請關閉 PR 並提醒他們可以在簽署 CLA 後重新開啟。請勿審閱作者未簽署 CLA 的 PR！
• 需要 LGTM：列出需要成員 LGTM 的 PR。如果 PR 需要技術審閱，請加入機器人建議的審閱者之一。如果內容需要修改，請內嵌新增建議與意見回饋。
• 已取得 LGTM，需要文件核准：列出需要 /approve 評論才能合併的 PR。
• 快速獲勝：列出針對 main 分支且沒有明顯阻礙的 PR。(在您處理 PR 時變更大小標籤中的 "XS" [XS, S, M, L, XL, XXL] )。
• 未針對主要分支：如果 PR 針對 dev- 分支，則適用於即將發行的版本。使用 /assign @<manager's_github-username> 指派 文件發行經理。如果 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 的情況下不會合併任何內容的低風險方法。

• 作者在 2 週或更長時間內未回覆評論或意見回饋。

不要害怕關閉提取請求。貢獻者可以輕鬆地重新開啟並繼續進行中的工作。通常，關閉通知會激發作者恢復並完成他們的貢獻。

若要關閉提取請求，請在 PR 上留下 /close 評論。

PR 管理員見習計畫

在 2021 年底，SIG Docs 推出了 PR 管理員見習計畫。推出該計畫是為了協助新貢獻者瞭解 PR 管理流程。

成為見習生

• 如果您有興趣以 PR 管理員的身分見習，請造訪 PR 管理員 Wiki 頁面 以查看今年的 PR 管理排程並註冊。

• 其他人可以在 #sig-docs Slack 頻道 上聯繫，要求在特定週見習指定的 PR 管理員。隨時聯繫 Brad Topol (@bradtopol) 或其中一位 SIG Docs 共同主席/主管。

• 一旦您註冊見習 PR 管理員，請在 Kubernetes Slack 上向 PR 管理員自我介紹。