简介
GitHub 代码质量(公开预览)通过在拉取请求和默认分支中展示代码质量问题,帮助保持代码的可靠性和可维护性。
在本教程中,你将学习如何在默认分支上识别并修复代码质量问题,从而提升仓库的代码健康度。
先决条件
- GitHub 代码质量必须在你的仓库中启用,并且代码必须使用受支持的语言。请参阅 启用 GitHub 代码质量。
- 如果你首次启用 GitHub 代码质量,请确保在启用后等待几分钟,以便对默认分支完成完整的 CodeQL 扫描。
审查默认分支的扫描结果
在你的仓库中,前往 安全与质量 选项卡,在左侧边栏点击 代码质量,然后点击 标准发现 打开仓库仪表盘。
这里你会看到
-
代码库的可靠性(Reliability)和可维护性(Maintainability)评分,这些评分帮助你一目了然地了解代码健康状况。
-
在默认分支上由 CodeQL 驱动的分析检测到的所有质量问题列表,按规则和语言进行分组。

识别高影响力的问题
使用仪表盘过滤器来识别高严重级别的问题(“Error”(错误)或 “Warning”(警告))。
解决这些问题将对你的仓库评分产生最大影响。

检查问题的详细信息
点击规则名称本身,可查看受该规则影响的文件和代码行的详细视图。

进入详细视图后,点击 “显示更多” 以获取上下文并理解结果。

生成 Copilot 自动修复
在高亮问题的右侧,点击 生成修复。

审查建议的修复,然后点击 “打开拉取请求”。
合并修复
仔细审查草稿拉取请求。如果你对提议的更改满意,并且所有检查和测试均通过,请继续合并该拉取请求。
观察指标变化
返回代码质量仪表盘( 安全与质量 选项卡,然后 代码质量,最后点击 标准发现)。
等待几分钟以完成下一次扫描——代码质量扫描会在每次向默认分支推送后自动重新运行。
观察仪表盘顶部指标的变化
-
“Reliability”(可靠性)或 “Maintainability”(可维护性)的发现数量应该已减少。
-
如果你的修复解决了多个高影响力的问题,你的 “Reliability”(可靠性)或 “Maintainability”(可维护性)评分可能已提升。
若想进一步了解评分的计算方式,请参阅 指标和评分参考。
结论
你已成功使用代码质量和 Copilot 自动修复来提升仓库的代码健康!
健康的代码更易于理解、维护和扩展,修复代码质量问题使代码库更可靠、合规,并加速后续开发。
后续步骤
- 了解 GitHub 代码质量在拉取请求中的工作原理,以防止代码质量问题进入默认分支。请参阅 在合并拉取请求前修复代码质量问题。
- 在社区讨论中提供对 GitHub 代码质量的反馈。