Thanks to visit codestin.com
Credit goes to docs.github.com

Skip to main content

解读存储库的代码质量评估结果

查看默认分支的 GitHub Code Quality 结果。

谁可以使用此功能?

具有写入访问权限的用户

GitHub Team 或 GitHub Enterprise Cloud

注意

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

先决条件

查看代码质量结果的完整积压列表

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

或者,如果要查看最近更改文件的 AI 驱动的分析结果,请参阅 使用 AI 提高最近合并代码的质量

浏览存储库的待处理项

“常规发现”仪表板显示 CodeQL 分析在存储库默认分支上找到的所有结果。 此视图可帮助你直观显示质量结果的完整积压工作,并优先处理特定类型的问题。

页面顶部的概述总结了代码库的可维护性和可靠性。

代码质量结果的“常规发现”仪表板屏幕截图。 摘要以深橙色显示。

在概述下面显示完整的结果列表,并附有包含过滤器的标题,这些过滤器可用于聚焦于特定的结果集。 结果如下:

  • 按检测到每个发现的规则分组
  • 在每个规则中,按字母顺序以文件路径排序

通过展开规则以列出受影响的文件,并单击规则名称查看结果的完整详细信息,来浏览结果。

代码质量的“常规发现”仪表板上“规则”表的屏幕截图。 “Overwritten property”规则名称以深橙色框出。

解释分级和指标

代码质量结果应始终在存储库的上下文中解释。 例如:

  • 小型存储库或只有少量使用受支持语言编写的代码的存储库,往往结果很少,评级良好。
  • 具有大量生成的代码的存储库可能有许多维护结果,降低了可维护性的评级。 如果源代码本身是可维护的,则这不是问题。
  • 具有大量完全支持语言的代码的大型存储库通常有许多结果,即使大多数代码具有良好的可维护性和可靠性标准也是如此。

若要详细了解指标以及如何计算分级,请参阅 指标和分级参考

后续步骤