指标和分级参考

本文提供用于 Code Quality指标和分级的定义。

您可以在** Security and quality** 选项卡中查看存储库的基于规则的结果，在常规发现 标签下的“代码质量”选项卡中。

指标定义

下表提供了针对存储库报告的每个指标的定义。

指标	Definition	示例发现
Reliability	评估代码是否正确、可预测且一致地执行其预期函数。 可靠代码不受 bug 影响，可安全地处理错误，并在正常和边缘情况下按预期运行。	性能、并发、错误处理、正确性、API 设计、辅助功能、国际化或安全性的问题
**

          **可维护性 | 评估理解、修改和扩展代码随时间推移是多么容易。 可维护的代码遵循最佳做法，避免不必要的复杂性，并组织方便将来的更改和协作。 | 不使用最佳做法、未使用/死代码、重复代码、复杂性、逻辑冗余、文档不充分、依赖项问题 |

严重性级别

严重性级别用于指示代码质量发现的潜在影响或紧迫性。 它们可帮助用户确定修正工作的优先级，并向利益干系人传达风险。 严重性由检测到问题的规则决定，遵循CodeQL 的约定和行业标准。

Severity	Definition
Error	表示可能导致 bug、故障或重大可维护性风险的高严重性问题。
警告	指示可能影响代码质量或可靠性的中等严重性问题，但并不立即至关重要。
注意	指示低严重性问题、轻微改进或建议。 这些发现对于代码的持续性健康状况和可维护性非常有用。

评级定义

这些评级用于汇总代码库的整体可靠性和可维护性，其依据是通过 CodeQL 扫描完整默认分支时发现的基于规则结果的严重性。

Rating	Definition	条件（基于调查结果）
优秀	代码库演示了可靠性和可维护性的最佳做法。	未检测到代码质量问题
良好	代码库存在低严重级别问题或仅需小幅改进。	至少 1 个“通知”级别的结果
一般	代码库具有中等严重性问题，这些问题可能会影响质量，但并不重要。	≥1“警告”等级发现
需要改进	代码库存在高严重级别问题，包括漏洞或重大可维护性风险。	至少 1 个“错误”级别的结果

延伸阅读

• 关于GitHub代码质量
• 解读存储库的代码质量评估结果