Skip to main content

Metrics and ratings reference

Understand the terminology used by GitHub to assess the quality of your repository's code.

이 문서의 내용

참고 항목

GitHub Code Quality은(는) 현재 공개 미리 보기에 있으며 변경될 수 있습니다. 공개 미리 보기에서 Code Quality은(는) 요금이 청구되지 않지만 Code Quality 스캔은 GitHub Actions 분을 소모합니다.

This article provides definitions for the metrics and ratings used by Code Quality.

You can see the rule-based results for your repository on your Security tab, in the 표준 결과 tab under " 코드 품질".

Metric definitions

The following table provides definitions for each metric that is reported for your repository.

MetricDefinitionExample findings
ReliabilityAssess whether the code performs its intended function correctly, predictably, and consistently. Reliable code is free from bugs, handles errors safely, and operates as expected under normal and edge-case conditions.Issues with performance, concurrency, error handling, correctness, API design, accessibility, internationalization, or security
MaintainabilityAssess how easy it is to understand, modify, and extend the code over time. Maintainable code follows best practices, avoids unnecessary complexity, and is organized for ease of future changes and collaboration.Not using best practices, unused/dead code, duplicate code, complexity, logical redundancies, inadequate documentation, dependency issues

Severity levels

Severity levels are used to indicate the potential impact or urgency of a code quality finding. They help users prioritize remediation efforts and communicate risks to stakeholders. Severity is determined by the rule that detected the issue, following conventions from CodeQL and industry standards.

SeverityDefinition
ErrorIndicates a high-severity issue that is likely to cause bugs, failures, or major maintainability risks.
WarningIndicates a moderate-severity issue that may impact code quality or reliability, but is not immediately critical.
NoteIndicates a low-severity issue, minor improvement, or recommendation. These findings are useful for ongoing code health and maintainability.

Ratings definitions

These ratings are used to summarize the overall reliability and maintainability of a repository based on the severity of rule-based results found by CodeQL scans of the full default branch:

RatingDefinitionCriteria (based on findings)
ExcellentCodebase demonstrates best practices for reliability and maintainability.No code quality findings detected
GoodCodebase has low-severity issues or minor improvements are suggested.≥1 "Note" level finding
FairCodebase has moderate-severity issues that may impact quality, but are not critical.≥1 "Warning" level finding
Needs ImprovementCodebase has high-severity issues, including bugs or major maintainability risks.≥1 "Error" level finding

Further reading