審查你的第一個 pull request
你會建立甚麼
標題為「你會建立甚麼」的章節完成本教學後,你將會:
- 在 Control Center 的 PR 工作台中開啟一個 pull request
- 閱讀它的 diff 並留下行內評論
- 提交審查判定
- 合併該 PR
先決條件:已完成派發你的第一個代理,而且在此工作區中已註冊的程式庫上有一個開啟中的 pull request。進行審查步驟時,請挑選一個不是你開啟的 PR —— 檢閱按鈕在你自己的 PR 上會被隱藏。合併在你建立的 PR 上仍然有效。
步驟 1:開啟 pull request
標題為「步驟 1:開啟 pull request」的章節- 在側邊欄中點擊 Pull requests
- 找到你的 PR 並點擊它
檢查點。 PR 會以分頁式工作台開啟 —— 總覽、Diff、原始碼控制、聊天、操作 —— 並聚焦於總覽:標題與操作、描述與活動時間軸,以及一個載有狀態、審查者、指派對象、檢查與已變更檔案的側邊欄。在那裡點擊某個檔案,會跳到 Diff 分頁中的該檔案。在有人要求 AI 審查之前,PR 檢閱分頁不會開啟。
步驟 2:閱讀 diff
標題為「步驟 2:閱讀 diff」的章節開啟 Diff 分頁。左側是可摺疊的檔案樹,而 diff 上方的橫條載有一個提交範圍選擇器 —— 可把 diff 收窄至單一提交或一段提交 —— 另有檔案數目,以及持續計算的新增與刪除行數。
diff 工具列中的設定按鈕控制它的呈現方式:
- 分欄或統一檢視
- 自動換行或捲動長行
- 程式碼字型連字
把檔案標記為已檢視,可在大型 diff 中追蹤你的進度。鍵盤導覽見鍵盤快捷鍵。
步驟 3:留下行內評論
標題為「步驟 3:留下行內評論」的章節- 將游標懸停在 diff 中的某一行 —— 行號欄會出現一個小小的
+按鈕 - 點擊它即可在該行留言,或先把它垂直拖曳以選取一個範圍
- 輸入你的意見。撰寫框提供兩種提交方式:
- 開始審查(若已有審查正在進行,則為加入審查)會把評論排入佇列。在你在步驟 4 提交判定之前,該討論串會顯示待提交的審查。
- 新增單一評論會立即把它發佈到 GitHub。該討論串會先顯示正在發佈…,然後顯示已同步,並在發佈失敗時提供重試。
本教學請使用開始審查,讓評論隨判定一併送出。
步驟 4:提交審查
標題為「步驟 4:提交審查」的章節- 在總覽的操作列中點擊檢閱 —— 同一個按鈕也在 Diff 分頁的工具列中。在你撰寫的 PR 上,以及在已關閉或已合併的 PR 上,它會被隱藏。
- 在撰寫框中撰寫摘要。它會自動儲存為草稿,因此你可以關閉浮層,之後再回來。
- 選擇一個判定:
- 要求變更
- 評論
- 批准
判定_就是_這個按鈕。按下批准或要求變更後,按鈕會改名為已批准或已要求變更。評論判定則讓按鈕保持檢閱標籤。
檢查點。 若你選擇了這兩者之一,按鈕會顯示「已批准」或「已要求變更」。
步驟 5:合併
標題為「步驟 5:合併」的章節只要 GitHub 回報該 PR 可合併,合併按鈕就會出現 —— 它不以你自己的批准為條件。它的顏色反映的是就緒程度而不是權限:必需的批准與檢查都已通過時採用主要色,檢查仍在執行時採用次要色,而被要求的審查者尚未批准或有檢查失敗時則採用破壞性顏色。
- 點擊合併
- 選擇一種方式:壓縮並合併、建立合併提交或變基並合併
- 對於前兩種,編輯已預填的提交標題與訊息
- 確認
任何尚未解決的問題 ——「檢查未通過」、「部分審查尚待完成」—— 都會在你確認之前列在浮出面板中。
合併之後會觸發一個 PrMerged 領域事件;分析與通知會取用它。其他會監聽的對象見領域事件。
以 AI 審查
標題為「以 AI 審查」的章節Control Center 可以把一條審查管線放到開啟中的 PR 上,但只在你要求時才會:pr_review 範本只有一個手動觸發器,別無其他。
- 開啟總覽操作列中的溢位選單,然後選擇詢問 AI。Control Center 會啟動這次執行並開啟 PR 檢閱分頁,讓你可以看著專家工作。
- 審查者代理會把他們的發現項記錄為該 PR 空間中的審查節點;最後一個步驟會把它們匯總成一份報告。
該管線刻意不發佈到 GitHub —— 它在匯總之後就結束。發佈是另一個由你親自採取的步驟,使用 PR 檢閱分頁上的發佈到 GitHub按鈕。見使用 AI 輔助審查。
你在工作台中開啟了 PR、閱讀了帶語法突顯的 diff、留下了行內評論、提交了判定並完成合併 —— 全程沒有離開應用程式。
下一步:建立你的第一條管線 來自動化多步驟工作流程。