指标和评级参考

注意

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

本文提供了代码质量使用的指标和评级的定义。

您可以在仓库的 安全与质量 选项卡下的 标准发现 选项卡中查看基于规则的结果。代码质量

指标定义

下表提供了对报告给您仓库的每个指标的定义。

指标	定义	示例发现
可靠性	评估代码是否能够正确、可预测且一致地执行其预期功能。可靠的代码没有错误，能够安全地处理异常，并在正常和边缘情况下按预期运行。	性能、并发、错误处理、正确性、API 设计、可访问性、国际化或安全性方面的问题
可维护性	评估随时间推移理解、修改和扩展代码的难易程度。可维护的代码遵循最佳实践，避免不必要的复杂性，并且组织结构便于将来的更改和协作。	未遵循最佳实践、未使用/死代码、重复代码、复杂度高、逻辑冗余、文档不足、依赖问题

严重性级别用于指示代码质量发现的潜在影响或紧迫性。它们帮助用户对修复工作进行优先级排序，并向相关方传达风险。严重性由检测到问题的规则决定，遵循 CodeQL 的约定和行业标准。

严重程度	定义
错误	表示一种高严重性问题，可能导致错误、故障或重大可维护性风险。
警告	表示一种中等严重性问题，可能影响代码质量或可靠性，但并非立刻危急。
注意	表示一种低严重性问题、轻微改进或建议。这些发现有助于持续的代码健康和可维护性。

这些评级用于根据 CodeQL 对完整默认分支的扫描所发现的基于规则的结果的严重性，对仓库的整体可靠性和可维护性进行概括。