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

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

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

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

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

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

解决标准问题

您可以单独解决发现项，也可以将多个发现项分配给 Copilot。

解决单个发现项

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

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

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

   is:open category:reliability severity:error

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

   

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

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

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

将多个发现分配给 Copilot

如果某条规则下有许多发现，并且想要高效地修正这些发现，则可以批量选择这些发现并将其分配给 Copilot 进行代理式修正。 Copilot 将打开一个合并请求，其中包含针对所选发现项的修复。

无需 Copilot 许可证即可使用此功能，但企业所有者必须为您的组织启用 Code Quality。 请参阅“允许在您的企业中使用 GitHub Code Quality”。

为了获得最佳结果，请从具有许多高严重级别问题的单条规则开始。 这样，便可以在扩展到其他规则之前，在一组连贯的更改上验证自动修复的质量。

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

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

3. 选择要修正的发现项。 每个页面最多可以选择 25 个发现项，一次一页。

4. 单击“分配到 Copilot”。

   

5. Copilot 将打开一个合并请求，其中包含针对所选发现项的修复。 在合并之前仔细查看拉取请求。

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

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

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

后续步骤

• 修复最近合并文件中的代码质量发现