Code reviews
使用內建的 Review 工作流程,直接在你的 IDE 中獲取 AI 驅動的程式碼審查。Bob 分析變更並在你提交工作前標記潛在問題。
為什麼使用程式碼審查?
- 早期發現錯誤:在問題進入已提交工作之前識別它們。
- 節省時間:主動應對審閱者的潛在評論,減少 PR 審批時間。
- 提高程式碼品質:獲取更好程式設計實踐和可維護性的建議。
- 與 issue 驗證:確保你的變更符合 issue 要求(需要 GitHub)。
運作方式
Review 工作流程完全在你的 IDE 中執行。Bob 提供專用的 Review 面板。使用 /review 命令開啟它。
Bob 審查所選分支之間的 diff,然後在 Bob Findings 面板中標記潛在問題。你可以選擇性地包含一個 GitHub issue,以驗證你的變更是否符合其要求。
審查以自動核准模式執行。Bob 無需手動確認即可完成所有分析步驟。
審查程式碼
前提條件
- 存取要比較的本地或遠端分支。
- 對於 issue 驗證:GitHub 帳戶和 issue URL(issue 相關功能需要 GitHub)。
Bob 可以使用 GitHub 和 GitLab 進行分支比較。但是,issue 驗證需要 GitHub。
發起審查
使用 /review 命令或 Review 面板圖示從側邊欄開啟 Bob Review 面板。該面板提供用於設定和啟動審查的視覺化介面。
從分支下拉選單中選擇要比較的分支。你可以與目前分支、本地分支、遠端分支或儲存庫的預設分支進行比較。
如果要包含尚未提交的本地修改,請切換包含未提交的變更。
可選地,從 issue 清單中選擇一個 GitHub issue,以驗證你的變更是否符合其要求。
點擊開始審查開始。
Bob 審查你的變更並在 Bob Findings 面板中顯示結果。
審查選項
選擇比較分支
分支下拉選擇器顯示:
- 目前分支:你的活動分支。
- 預設分支:儲存庫的預設分支(帶徽章標記)。
- 遠端分支:來自遠端儲存庫的分支(帶徽章標記)。
- 本地分支:其他本地分支(帶徽章標記)。
你可以比較遠端 main 與本地 main、目前分支與任何其他分支,或任何 ref 的組合。
顯示未提交的變更
啟用包含未提交的變更核取方塊,將未提交的本地修改包含在審查中。審查目前分支時,此選項會自動啟用。
設定審查排除項目
你可以從程式碼審查中排除特定檔案或模式:
開啟 Bob 設定。
導覽至 Bob Findings 索引標籤。
在審查排除項目下,新增要排除的檔案的 glob 模式(例如 .vscode/**、*.test.ts)。
排除的檔案不會出現在審查面板的檔案清單中,也不會在審查期間被分析。
使用 Bob Findings
Bob 完成審查後,結果會顯示在 Bob Findings 面板中。你可以透過多種方式與這些結果進行互動:
檢視結果
- 點擊 Bob Findings 面板中的任何結果以查看完整詳情。
- 在聊天介面上下文下拉選單中使用
@issues在對話中參照結果。 - 點擊結果導覽至檔案,以在上下文中查看帶有內嵌注釋的程式碼。
有關上下文提及的更多資訊,請參閱上下文提及。
對結果採取行動
每個結果提供以下操作:
- 用 Bob 修復:請求 Bob 自動修復問題。Bob 將建立一個任務來處理該結果。
- 忽略:如果不相關,從面板中移除該結果。
提示和最佳實踐
- 與手動審查結合:在人工程式碼審查之前,將 Bob 的自動審查作為第一輪。
- 驗證 issue 涵蓋率:在建立 pull request 之前,包含一個 GitHub issue,以確保你的變更完全符合要求。
- 設定排除項目:排除不需要審查的測試檔案、產生的程式碼或設定檔。
- 與遠端分支比較:使用分支選擇器,對照最新的遠端變更審查你的工作。