拉取请求

为什么使用此功能？

• 节省时间：根据您的更改自动生成详细的 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 之前查看和编辑生成的描述。