拉取請求

為什麼使用此功能？

• 節省時間：根據您的變更自動產生詳細的 PR 說明。
• 維持一致性：確保所有 PR 遵循一致的格式。
• 改善協作：透過結構良好的說明為審查者提供清晰的情境。
• 簡化工作流程：無需離開 IDE 即可建立 PR。

運作方式

Bob 會分析您的分支變更、提交歷史記錄和分支名稱，以了解您工作的目的和範圍。然後它會產生有意義的 PR 標題和詳細說明，總結您的變更，讓審查者更容易了解 PR 的情境和目的。產生後，您可以在提交前檢閱和編輯 PR 說明。

PR 產生過程是互動式的，讓您在建立 PR 之前選擇目標分支和遠端儲存庫。

開始使用

先決條件

• 您的變更必須提交到分支。
• 您必須具有遠端儲存庫的推送存取權限。

基本用法

您可以從 3 個選項中選擇以啟動 PR 流程：

• 點擊原始檔控制面板中的 PR 圖示。
• 使用命令選擇區（Mac 上的 Cmd + Shift + P，Windows/Linux 上的 Ctrl + Shift + P）並搜尋「Bob: Generate PR」。
• 在 Bob 聊天介面中輸入 /create-pr。

Bob 接著會引導您完成以下步驟：

1. 選擇您想要合併到的基礎分支。Bob 會建議三個最可能的分支。
2. 如果您有多個遠端，請選擇遠端儲存庫。
3. 檢閱產生的 PR 說明和標題。
4. 建立 PR。
5. 在聊天中取得新建立的 PR 連結。

使用範本產生 PR 說明

Bob 會在產生拉取請求說明時自動偵測並使用專案現有的 PR 範本。這確保您的 PR 與團隊建立的標準保持一致。當 Bob 在專案中偵測到多個 PR 範本時，您可以選擇要套用到拉取請求的範本。

範本偵測

Bob 會在相對於專案根目錄的以下位置搜尋 PR 範本：

1. ${cwd}/pull_request_template.md
2. ${cwd}/docs/pull_request_template.md
3. ${cwd}/.github/pull_request_template.md
4. ${cwd}/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
5. ${cwd}/PULL_REQUEST_TEMPLATE/pull_request_template.md
6. ${cwd}/docs/PULL_REQUEST_TEMPLATE/pull_request_template.md

如果 Bob 找到多個範本，Bob 會要求使用者選擇要用於 PR 說明的範本。

預設範本

如果在專案中找不到範本，Bob 會使用內建範本，其中包括：

• 從分支名稱衍生的描述性標題
• 變更摘要
• 關鍵實作詳細資訊
• 測試資訊
• 任何相關連結或參照

編輯產生的說明

產生 PR 說明後，Bob 會直接在聊天中呈現該說明。你可以：

• 確認並繼續：按原樣核准說明，繼續建立 PR。
• 要求變更：在聊天中輸入你的意見，Bob 將根據你的指示重新產生說明。你可以在確認前視需要反覆修改。

自訂範本

為了獲得 Bob PR 產生的最佳結果：

• 在範本中使用清晰的區段標題（例如 ## Summary、## Changes）
• 包含提供情境的佔位符文字（例如 <!-- Describe the purpose of this PR -->）
• 考慮新增測試指示和相關問題的區段

提示和最佳實務

• 使用描述性的分支名稱以協助 Bob 產生更準確的 PR 說明。
• 在建立 PR 之前檢閱和編輯產生的說明。