跳至主要内容

解读仓库的代码质量结果

查看默认分支的 GitHub 代码质量发现。

谁可以使用此功能?

具有 写入 访问权限的用户

GitHub 团队或 GitHub 企业云

注意

GitHub 代码质量目前处于公开预览阶段,可能会有变更。在公开预览期间,代码质量不会产生费用,但代码质量扫描会消耗 GitHub Actions 分钟数。

先决条件

查看完整的代码质量结果待办列表

  1. 导航至仓库的 安全与质量 选项卡。
  2. 点击展开 代码质量,随后点击 标准发现

如果想查看最近更改文件的 AI 驱动发现,请参阅 使用 AI 改进近期合并代码的质量

探索仓库的待办列表

“标准发现”仪表盘展示了在仓库默认分支上由 CodeQL 分析得到的全部结果。该视图帮助您直观看到完整的质量结果待办列表,并可对特定类型的问题进行优先修复。

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

Screenshot of the "Standard findings" dashboard for code quality results. The summary is outlined in dark orange.

在概览下方,会显示完整的结果列表,并提供带有过滤器的标题,您可以使用这些过滤器聚焦于特定的发现集合。结果被

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

通过展开规则来列出受影响的文件,或点击规则名称查看该发现的完整详情,以进一步探索结果。

Screenshot of the Rules table on the "Standard findings" dashboard for code quality. The "Overwritten property" rule name is outlined in dark orange.

解释评级和指标

代码质量结果应始终结合仓库的实际情况进行解读。例如:

  • 代码量较小,或仅使用受支持语言编写少量代码的仓库,通常会产生较少的结果并获得较好的评级。
  • 包含大量生成代码的仓库可能会出现许多维护类结果,从而降低可维护性评分。如果源代码本身可维护,这并不是问题。
  • 在完全受支持语言中拥有大量代码的大型仓库,即便大多数代码符合良好的可维护性和可靠性标准,也往往会产生大量结果。

欲了解更多关于指标及评级计算方式,请参阅 指标与评级参考

后续步骤

© . This site is unofficial and not affiliated with GitHub, Inc.