Skip to main content

使用 AI 提高最近合并代码的质量

浏览最近合并代码的 GitHub Code Quality 结果,使用Copilot自动修复 修复或将修正工作委托给 Copilot云代理。

谁可以使用此功能?

具有写入访问权限的用户

GitHub Team 或 GitHub Enterprise Cloud

注意

GitHub Code Quality 当前正处于 公共预览版 阶段,并可能会发生变化。 在 公共预览版期间,Code Quality 不会计费,尽管 Code Quality 扫描将使用 GitHub Actions 分钟。

介绍

本教程介绍如何浏览和修正由 Code Quality 的 AI 分析最近合并到默认分支的代码时检测到的质量问题。

提高最近合并的文件的质量时,可减少存储库中的技术债务,并使其他开发人员更轻松地处理正在积极开发的文件。

          Code Quality 有两道防线

          Code Quality 扫描拉取请求并评论质量问题,然后在合并拉取请求后 **运行第二次 AI 扫描** 。 这两种类型的扫描使用互补技术:
  •           **拉取请求扫描**使用 CodeQL 规则来识别问题。 此分析经过全面测试,善于识别代码与质量规则不匹配的位置,并且可以分析许多文件。 但是,它支持一部分编码语言,并且无法识别不存在规则的问题。
    
  •           **最近合并文件扫描**使用大语言模型分析最近更改的文件,并报告最多 5 个文件的结果。 此分析检视所有语言的代码而不受规则限制,并提供可以超越CodeQL规则所能提供的上下文见解和建议。
    

先决条件

  • Code Quality 已启用,请参阅 启用 GitHub Code Quality
  • 自 Code Quality 启用以来,至少有一个拉取请求已合并。

1.查看存储库的 AI 建议

对默认分支上最近合并的文件进行 Code Quality 扫描后,你可在 AI 发现 视图下查看结果,该视图显示最多个 5 文件的结果。

  1. 请导航到您的存储库中的** Security and quality** 选项卡。
  2. 单击以展开 代码质量,然后单击 AI 发现

注意

如果存储库处于非活动状态,或者 LLM 分析无法建议在最近推送到默认分支时提高代码质量的方法,则此视图为空。

2. 浏览存储库的建议改进

AI 发现 页面上,列出了每个文件,包括识别出的质量问题数量和文件推送到默认分支的时间。

  • 单击文件名可查看检测到的质量问题的详细信息和建议的修补程序。

代码质量的“AI 发现”视图的屏幕截图。

3. 委托修复工作或自行创建拉取请求

可以打开拉取请求,将建议的自动修复应用到文件,或将修正工作委托给 Copilot云代理。 需要 Copilot 许可证才能将工作分配给 Copilot云代理。
注册 Copilot

将工作委托给 Copilot云代理

你可请求 云代理 打开拉取请求,以建议更改作为提示改进文件。 如果建议的更改看起来不错,并且你想要打开一个将修补程序应用于多个文件的拉取请求,则这是最佳选择。

要委托拉取请求创建:

  • 多个文件: 选择要包含的文件,然后在文件列表的标头中单击将所选内容分配给Copilot
  • 一个文件: 单击 将文件分配给 Copilot

当 云代理 设置工作时会有延迟。 当拉取请求处于打开状态并且工作正在进行时,将显示一个横幅,其中包含拉取请求的链接。

可以跟踪 Copilot云代理'工作:

自行创建拉取请求

您可以自行打开拉取请求并应用自动修复建议。 这是最佳选择如果:

  • 你希望在打开拉取请求前在本地或 GitHub Desktop 中处理更改
  • 您无权访问 Copilot云代理

注意

自行创建拉取请求时,一次只能提交对一个文件的修复。 若要一次性修复多个文件,必须使用 Copilot云代理。

打开拉取请求

  1. 单击文件名可查看检测到的质量问题的详细信息。

  2. 审查问题和建议的解决方案。

  3. 展开 “分配到 Copilot ”下拉列表,然后单击“ 打开拉取请求 ”,将默认选项更改为“打开拉取请求”。 你的偏好已被记住。

    代码质量的“AI 发现”视图的屏幕截图。

  4. 单击“ 打开拉取请求 ”以打开提交选项对话框。

  5. 单击 “提交更改”以创建带有修复的拉取请求。

4. 为拉取请求的审阅者提供背景信息

提供关于你建议更改代码的原因的上下文是鼓励团队成员查看拉取请求的最佳方式。 如果您使用了 Copilot云代理,则拉取请求摘要已经包括了该拉取请求修复的问题的完整详细信息。

如果直接从 GitHub Code Quality 视图中打开拉取请求,拉取请求摘要会链接到“AI 发现”视图。 可以考虑将 AI 发现 视图中的一些说明复制到拉取请求摘要中。

GitHub Code Quality 创建的拉取请求摘要的屏幕截图。

5. 查看所做的更改对 AI 发现

产生影响

合并拉取请求后返回“AI 发现”视图时,已修复的结果不再列出。

后续步骤