功能

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,以确保你的变更完全满足要求。
  • 配置排除项:排除不需要审查的测试文件、生成的代码或配置文件。
  • 与远程分支比较:使用分支选择器,对照最新的远程变更审查你的工作。
这个主题怎么样?