Skip to content

interpret-results.md

Latest commit

 

History

History
55 lines (38 loc) · 3.34 KB

interpret-results.md

File metadata and controls

55 lines (38 loc) · 3.34 KB
Raw
title Interpreting the code quality results for your repository
shortTitle Interpret results
allowTitleToDifferFromFilename true
intro Use {% data variables.product.prodname_code_quality_short %} results to assess the maintainability and reliability of your codebase, so your teams can focus remediation where it matters most.
versions
feature
code-quality
product {% data reusables.gated-features.code-quality-availability %}
permissions {% data reusables.permissions.code-quality-see-repo-findings %}
audience
driver
contentType how-tos
redirect_from
/code-security/code-quality/how-tos/interpret-results
category
Improve code quality

Prerequisites

  • {% data variables.product.prodname_code_quality_short %} is enabled, see AUTOTITLE.

Viewing the full backlog of code quality results

{% data reusables.code-quality.dashboard-navigation-repo %} {% data reusables.code-quality.dashboard-all-findings %}

Alternatively, if you want to view AI-powered findings for the most recently changed files, see AUTOTITLE.

Exploring the backlog for your repository

The "{% data variables.code-quality.all_findings %}" dashboard shows all the results found by {% data variables.product.prodname_codeql %} analysis on the default branch of your repository. This view helps you visualize the full backlog of quality results and prioritize work to fix specific types of problems.

The overview, at the top of the page, summarizes the maintainability and reliability of the codebase.

Screenshot of the "{% data variables.code-quality.all_findings %}" dashboard for code quality results. The summary is outlined in dark orange.

Underneath the overview, the full list of results is shown with a header with filters that you can use to focus on a specific set of findings. The results are:

  • Grouped by the rule that detected each finding
  • Within each rule, ordered by file path alphabetically

Explore the results by expanding a rule to list the affected files and clicking on the name of a rule to see full details of the findings.

Screenshot of the Rules table on the "{% data variables.code-quality.all_findings %}" dashboard for code quality. The "Overwritten property" rule name is outlined in dark orange.

Interpreting scores and metrics

Code quality results should always be interpreted in the context of your repository. For example:

  • Small repositories, or repositories with only a small amount of code written in supported languages, tend to have few results and good scores.
  • Repositories with a lot of generated code may have many maintenance results, lowering the score for maintainability. This is not a problem if the source code itself is maintainable.
  • Large repositories with a lot of code in a fully supported language often have many results even if the majority of the code has good maintainability and reliability standards.

To learn more about the metrics and how the scores are calculated, see AUTOTITLE.