Skip to content

Commit 1e59176

Browse files
authored
Opportunities to clarify "Standard findings" vs "AI findings" in the Code Quality docs #20522 (#58608)
1 parent 6857cdf commit 1e59176

File tree

6 files changed

+9
-7
lines changed

6 files changed

+9
-7
lines changed

content/code-security/code-quality/concepts/about-code-quality.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ With {% data variables.product.prodname_code_quality_short %}, you can:
4242

4343
{% data reusables.code-quality.codeql-supported-languages %}
4444

45-
Code quality problems in other languages are detected by AI analysis alone. For more information on analysis, see [AUTOTITLE](/code-security/code-quality/responsible-use/code-quality).
45+
{% data variables.product.prodname_code_quality_short %} also performs AI-powered analysis with results displayed separately on the "**{% data variables.code-quality.recent_suggestions %}**" repository dashboard. Unlike the rule-based {% data variables.product.prodname_codeql %} analysis that scans the entire codebase and pull requests, this AI-powered analysis only examines files recently pushed to the default branch and may identify issues in languages beyond those listed above. For more information, see [AUTOTITLE](/code-security/code-quality/responsible-use/code-quality).
4646

4747
## Understanding where {% data variables.product.prodname_code_quality_short %} findings appear after enablement
4848

content/code-security/code-quality/get-started/quickstart.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ In this tutorial, you’ll learn how to identify and fix a code quality finding
2121
### Prerequisites
2222

2323
* {% data variables.product.prodname_code_quality %} must be enabled for your repository and you must have code in a supported language. See [AUTOTITLE](/code-security/code-quality/how-tos/enable-code-quality).
24-
* If you're enabling {% data variables.product.prodname_code_quality %} for the first time, ensure you've waited a few minutes after enablement for a scan of the default branch to complete.
24+
* If you're enabling {% data variables.product.prodname_code_quality %} for the first time, ensure you've waited a few minutes after enablement for a full {% data variables.product.prodname_codeql %} scan of the default branch to complete.
2525

2626
## Review scan results for your default branch
2727

@@ -30,7 +30,7 @@ In your repository, go to the **Security** tab, click **{% data variables.code-q
3030
Here you'll see:
3131

3232
* Ratings for the **Reliability** and **Maintainability** of your codebase, which help you understand your code health at a glance.
33-
* A **results list** of all the quality issues detected on your default branch, which are grouped by rule and language.
33+
* A **results list** of all the quality issues detected by a {% data variables.product.prodname_codeql %}-powered analysis on your default branch, which are grouped by rule and language.
3434

3535
![Screenshot of code quality ratings in the "{% data variables.code-quality.all_findings %}" view for {% data variables.product.prodname_code_quality_short %}.](/assets/images/help/code-quality/all-findings-overview-repo.png)
3636

content/code-security/code-quality/how-tos/interpret-results.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ Code quality results should always be interpreted in the context of your reposit
5050
* Repositories with a lot of generated code may have many maintenance results, lowering the rating for maintainability. This is not a problem if the source code itself is maintainable.
5151
* 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.
5252

53+
To learn more about the metrics and how the ratings are calculated, see [AUTOTITLE](/code-security/code-quality/reference/metrics-and-ratings).
54+
5355
## Next steps
5456

5557
* Remediate quality findings in your default branch and improve the maintainability and reliability rating for your repository. See [AUTOTITLE](/code-security/code-quality/tutorials/improve-your-codebase).

content/code-security/code-quality/tutorials/fix-findings-in-prs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ Catching code quality issues early keeps your team's codebase in shape. {% data
2626

2727
## 1. Understand how {% data variables.product.prodname_code_quality %} works on pull requests
2828

29-
When you open a pull request, {% data variables.product.prodname_code_quality %} automatically scans your changes for quality issues like those described above.
29+
When you open a pull request, {% data variables.product.prodname_code_quality %} uses {% data variables.product.prodname_codeql %} to automatically scan your changes for quality issues like those described above.
3030

31-
The results of the scan are reported as comments on your pull request, left by the `{% data variables.code-quality.pr_commenter %}`. Each comment corresponds to a specific code quality problem that was detected in your changes, and comes with a suggested autofix.
31+
The results of the {% data variables.product.prodname_codeql %} scan are reported as comments on your pull request, left by the `{% data variables.code-quality.pr_commenter %}`. Each comment corresponds to a specific code quality problem that was detected in your changes, and comes with a suggested autofix.
3232

3333
Comments are labeled by severity (**Error**, **Warning**, **Note**), so you can see which findings are the most critical to address.
3434

content/code-security/code-quality/tutorials/improve-recent-merges.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ redirect_from:
1717

1818
## Introduction
1919

20-
This tutorial shows you how to explore and remediate quality issues that have been detected by {% data variables.product.prodname_code_quality_short %}'s analysis of code that was recently merged into your default branch.
20+
This tutorial shows you how to explore and remediate quality issues that have been detected by {% data variables.product.prodname_code_quality_short %}'s AI-powered analysis of code that was recently merged into your default branch.
2121

2222
When you improve quality of recently merged files, you reduce technical debt in the repository and make it easier for other developers to work on files that are under active development.
2323

content/code-security/code-quality/tutorials/improve-your-codebase.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This tutorial guides you through using {% data variables.product.prodname_code_q
2020
### Prerequisites
2121

2222
* {% data variables.product.prodname_code_quality_short %} is enabled for your repository. See [AUTOTITLE](/code-security/code-quality/how-tos/enable-code-quality).
23-
* A full scan of the default branch has completed.
23+
* If you're enabling {% data variables.product.prodname_code_quality %} for the first time, ensure you've waited a few minutes after enablement for a full {% data variables.product.prodname_codeql %} scan of the default branch to complete.
2424

2525
## 1. Assess your repository's overall code health
2626

0 commit comments

Comments
 (0)