修复代码库待办事项中的代码质量问题

为存储库的默认分支上的查找生成自动修复，或者消除与不相关的发现。

谁可以使用此功能？

具有写入访问权限的用户

GitHub Team 或 GitHub Enterprise Cloud

在本文中

提示

如果你不熟悉 Code Quality，请参阅 提高存储库的代码质量分数 ，获取查看和改进存储库质量分数的引导式演练。

Code Quality 如何在您的默认分支上运行

Code Quality 会扫描您的默认分支，并在您的仓库的 代码质量 选项卡中的“ Security and quality”页面上报告发现结果。 它运行 两种类型的分析。

  1. ** 常规发现 **：Code Quality 使用 CodeQL 对默认分支执行确定性的、基于规则的扫描。 结果按规则和语言分组，并按严重程度（错误、警告、提示）进行标记，每条结果都包含一个建议的自动修复方案。

  2. ** AI 发现 **： Code Quality 使用 AI 驱动的分析来识别最近推送到默认分支的文件中的质量问题，包括基于规则的分析可能无法检测到的问题，例如最佳做法、命名约定或设计注意事项。

注意

最近更改文件的“AI 发现”页当前处于 公开预览 状态，可能会更改。

有关解析 AI 发现的信息，请参阅 修复最近合并文件中的代码质量发现。

解决标准发现项

  1. 请导航到您的存储库中的** Security and quality** 选项卡。

  2. 单击以展开 代码质量，然后单击 常规发现。

  3. 使用仪表板筛选器专注于最有可能影响质量分数的调查结果。 例如，若要查看“可靠性”的所有“错误”级别结果，请将筛选器设置为：

    is:open category:reliability severity:error

  4. 结果按规则分组。 单击规则名称以查看该规则的所有结果的详细视图。

    “标准发现”视图中某条规则的屏幕截图。 规则名称以深橙色突出显示。

  5. 单击“ 显示更多”，然后查看规则的说明、建议的修补程序、支持代码示例和引用。

显示代码质量规则结果的屏幕截图。 文本“显示更多”以深橙色突出显示。

  1. 在单个发现项的右侧，单击生成修复方案。
  2. 查看拟议更改的差异。 如果同意该请求，请单击“ 打开拉取请求”。
  3. 在“将自动修复提交到分支”对话框中，选择“创建拉取请求”，然后单击 提交更改。
  4. 当自动修复拉取请求可供审查时，将其状态从“草稿”更改为“可供审查”，并在合并前等待 CI 检查通过。
  5. 或者，如果发现不相关或可操作，请单击“ 消除”。 例如，你可能会忽略某项发现：它出现在已不再维护的遗留代码中，属于团队编码标准中的已知例外情况，或者只是不会带来实际质量风险的误报。

若要提高可维护性或可靠性分数，必须解决当前影响该指标的最高严重级别的每个发现。 请参阅“指标和评分参考”。

验证代码质量分数是否已更新

在您的自动修复拉取请求合并后，返回到“常规发现”视图以确认：

  • 发现次数已减少。
  • 如果解决了该指标的当前最低严重性级别的所有发现，可维护性或可靠性分数已得到改善。

后续步骤