查看GitHub Copilot代码评审特性

已完成

GitHub Copilot可以查看代码并提供反馈。

Visual Studio Code中的GitHub Copilot代码评审支持两种类型的评审:

  • 审阅选择:突出显示代码并请求进行初始评审。
  • 查看更改:请求对所有更改进行更深入的评审。

以下表格总结了这两种评审类型的当前功能和可用性:

功能 / 特点 查看所选内容 查看更改
提供于 Visual Studio Code Visual Studio Code和GitHub网站
高级/标准功能 适用于所有GitHub Copilot订阅者的标准功能 高级功能。 适用于 GitHub Copilot Pro、GitHub Copilot Pro+、GitHub Copilot Business 和 GitHub Copilot Enterprise 计划。 适用每人每月配额。
说明 对突出显示的代码部分进行初步评审,并提供反馈和建议 对所有更改进行深入评审
语言支持 全部 C、C#、C++、Go、Java、JavaScript、Kotlin、Markdown、Python、Ruby、Swift、TypeScript。
自定义编码指南支持 是的

代码评审每月配额

GitHub Copilot 代码评审的“评审更改”类型是一项高级功能,有每人每月配额限制。 配额当前处于活动状态。

当你将 GitHub Copilot 指定为拉取请求的审查者时,每次 GitHub Copilot 向拉取请求发布评论,都会从你的每月配额中扣除一个高级请求。

如果存储库配置为自动请求GitHub Copilot对所有新拉取请求的代码评审,则高级请求使用情况将计入拉取请求作者的配额。 如果拉取请求由 GitHub Actions 或机器人创建,使用量将计入触发工作流的用户(如可识别)或指定的计费所有者。

达到每月配额时,除非您升级GitHub Copilot计划或启用更多高级请求,否则将无法从GitHub Copilot获取代码评审,直到配额重置。

警告

GitHub Copilot不能保证在拉取请求中发现所有问题,有时也会出错。 始终仔细验证GitHub Copilot的反馈,并通过人工评审补充GitHub Copilot的反馈。

使用代码评审功能

GitHub Copilot可以帮助审查您的代码,无论是您在编辑器中选择的代码块,还是拉取请求中包含的所有更改(这需要安装GitHub拉取请求扩展)。

在代码编辑器中查看选定的代码块

审阅 智能操作提供了一种审阅和分析代码的方法。 它可以帮助你确定改进领域、建议重构更新,并提供有关最佳做法的指导。 代码评审功能生成的建议可帮助你提高代码的质量、可靠性、性能和安全性。

  1. 在编辑器中打开代码文件。

  2. 选择要查看的代码。

  3. 右键单击所选代码,然后选择生成代码 > 审查

    代码评审代理在 COMMENTS 面板(代码编辑器下方)中创建评论,并直接在代码编辑器中显示建议的更新。

    注释

    GitHub Copilot 的 Visual Studio Code 上下文菜单正在积极地更新。 “审阅智能”操作可能显示在上下文菜单的顶层(与“说明”一起),而不是在“生成代码”下显示。 如果上下文菜单中没有“ 审阅 ”选项,可以通过选择代码并在聊天视图中直接输入“查看此代码”等提示来执行相同的操作。

  4. 浏览建议,选择应用或放弃这些更新。

    屏幕截图显示带有建议代码更改差异和“应用”及“放弃”按钮的代码审查评论。

    如果可能,Copilot的反馈包括建议的代码更改。 使用 应用并转到下一步 接受建议,或 放弃并转到下一步 以拒绝该建议。 应用的更改不会被自动提交。

查看对代码库的所有更改

GitHub Copilot 代码评审功能提供了一种方法来审查代码库的所有已暂存或未暂存的更改。 它可以帮助你确定改进领域、建议重构更新,并提供有关最佳做法的指导。 代码评审功能生成的建议可帮助你提高代码的质量、可靠性、性能和安全性。

  1. 在Visual Studio Code中,切换到“源代码管理”视图。

  2. 若要请求审阅未标记的更改,请将鼠标指针悬停在 CHANGES 上,然后选择GitHub Copilot代码评审 - 未提交的更改按钮。

    截图显示在源代码管理视图中的GitHub Copilot代码审阅按钮。

  3. 等待GitHub Copilot查看更改。 这通常需要不到 30 秒。

  4. 如果 GitHub Copilot 有任何评论,这些评论将内联显示在你的文件中以及“问题”选项卡中。

    如果可能,Copilot的反馈包括建议的代码更改。 使用 应用并转到下一步 来接受建议,或使用 放弃并转到下一步 来拒绝建议。 应用更改不会自动提交。

使用编码准则自定义代码评审

您可以通过向存储库添加自定义说明来定制Copilot对您的代码的检查方式。 这适用于评审更改类型的审查。

.github/copilot-instructions.md 文件中指定存储库范围的自定义说明。 例如:

When performing a code review, focus on readability and avoid nested ternary operators.
When performing a code review, flag any use of hardcoded credentials.

还可以在 .github/instructions/**/*.instructions.md 文件中创建特定于路径的说明,Copilot仅在查看与指定路径匹配的文件时才使用。

注释

Copilot代码检查仅读取任何自定义指令文件的前4000个字符。 超出此限制的说明不会影响生成的评论。

概要

GitHub Copilot可以查看代码并提供反馈。 Visual Studio Code 中的 GitHub Copilot 代码审查支持两种类型的审查:评审选定内容和评审更改。 “Review 智能功能提供了审核和分析所选代码的方式。” 它可以帮助你确定改进领域、建议重构更新,并提供有关最佳做法的指导。 GitHub Copilot代码评审功能提供了一种使用Visual Studio Code的源码控制视图查看暂存或未暂存更改的方法。