介绍
GitHub Code Quality (公共预览版) 通过在拉取请求和默认分支中显示代码质量结果,帮助保持代码的可靠性和可维护性。
本教程介绍如何识别和修复默认分支上的代码质量查找,帮助改进存储库的代码运行状况。
先决条件
- GitHub Code Quality 必须为您的存储库启用,并且您的存储库中必须包含支持的语言的代码。 请参阅“启用 GitHub Code Quality”。
- 如果您是首次启用 GitHub Code Quality ,请在启用后等待几分钟,以确保默认分支的 CodeQL 扫描能够完全完成。
查看默认分支的扫描结果
在存储库中,转到 Security and quality 选项卡,单击 代码质量 左侧栏中,然后单击 常规发现 以打开存储库仪表板。
你将在此处看到:
-
代码库可靠性和****可维护性的分级,可帮助你一目了然地了解代码运行状况。
-
默认分支上由 CodeQL 支持的分析检测到的所有质量问题的结果列表,按规则和语言分组。

确定影响重大的发现
使用 仪表板筛选器 来识别高严重性级别的问题(“错误”或“警告”)。
解决这些问题将对存储库的评级产生最大的影响。

查看发现的详细信息
单击规则名称本身可查看受该规则影响的文件和代码行的详细视图。

进入详细视图后,单击“ 显示更多 ”以收集上下文并了解结果。

生成 Copilot自动修复
在突出显示的发现右侧,单击“ 生成修复”。

查看建议的更改,然后单击“ 打开拉取请求”。
合并修复
仔细审查拉取请求草稿。 如果对提议的更改满意,且所有检查和测试均通过,则合并拉取请求。
观察指标更改
返回到 Code Quality 仪表板( Security and quality 选项卡,然后 代码质量,然后 常规发现)。
等待几分钟,等待下一次扫描完成 — Code Quality 每次推送到默认分支后,扫描会自动重新运行。
观察仪表板顶部指标的变化:
-
“可靠性”或“可维护性”的发现数量应已减少。
-
如果你的修补程序解决了许多影响重大的发现,则“可靠性”或“可维护性” 的评级 可能会有所改善。
若要详细了解如何计算分级,请参阅 指标和分级参考。
结论
已成功使用 Code Quality 和 Copilot自动修复 改进存储库的代码运行状况!
正常的代码更易于理解、维护和扩展,并修正代码质量问题,使代码库更加可靠、合规并加快未来开发。
后续步骤
- 了解 GitHub Code Quality 如何处理拉取请求,以防止代码质量问题到达默认分支。 请参阅“在合并拉取请求之前修复代码质量问题”。
- 在
社区讨论 中提供关于的反馈。