Skip to content

Commit 3a76117

Browse files
mchammer01Copilotcarogalvin
authored
[Improvement] - Add a dedicated GitHub Code Quality overview article (#64423)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Caro Galvin <carogalvin@github.com> Copilot-Session: c7d6e32d-752a-4c44-bd13-f5c8ed0116d9 Copilot-Session: 4a534c4c-be9d-4c22-8fe9-1544b2a09fa7
1 parent 9b4fb7d commit 3a76117

3 files changed

Lines changed: 43 additions & 1 deletion

File tree

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: About GitHub Code Quality
3+
intro: 'Decide whether {% data variables.product.prodname_code_quality %} meets your team''s needs, how it complements other {% data variables.product.github %} products, and what to consider before purchasing.'
4+
product: '{% data reusables.gated-features.code-quality-availability %}'
5+
versions:
6+
feature: code-quality
7+
shortTitle: GitHub Code Quality
8+
category:
9+
- Explore GitHub plans and features
10+
---
11+
12+
## About {% data variables.product.prodname_code_quality %}
13+
14+
{% data variables.product.prodname_code_quality %} analyzes your code for quality and coverage issues using {% data variables.product.prodname_codeql %} rules and AI-powered analysis.
15+
16+
* On pull requests, findings appear as inline comments with one-click {% data variables.product.prodname_copilot_short %}-powered fixes, so new quality debt doesn't accumulate before code is merged.
17+
* On your default branch, scans surface existing quality debt. You can apply autofixes directly, or delegate remediation to {% data variables.copilot.copilot_cloud_agent %}.
18+
19+
You can enforce quality thresholds with rulesets to block pull requests that don't meet your team's standards. To also enforce line coverage thresholds, upload a Cobertura XML coverage report from your tests.
20+
21+
To purchase {% data variables.product.prodname_code_quality %}, see {% data variables.product.pricing_link %}. For more information, including supported languages, see [AUTOTITLE](/code-security/concepts/code-quality/code-quality).
22+
23+
## How {% data variables.product.prodname_code_quality_short %} fits with other {% data variables.product.github %} products
24+
25+
{% data variables.product.prodname_code_quality_short %} is purchased separately from {% data variables.product.prodname_GHAS %} and {% data variables.product.prodname_copilot_short %}. It focuses on metrics related to code quality, such as code coverage. {% data variables.product.prodname_GHAS %} products focus on security, and {% data variables.copilot.copilot_code-review_short %} provides AI-powered feedback on pull requests.
26+
27+
{% data variables.product.prodname_code_quality_short %} enforces deterministic quality and coverage rules that you can use to block merges, while {% data variables.copilot.copilot_code-review_short %} gives broader, conversational AI feedback. Many teams use both: {% data variables.copilot.copilot_code-review_short %} for general review, and {% data variables.product.prodname_code_quality_short %} for enforceable standards.
28+
29+
## Costs to consider
30+
31+
Before purchasing {% data variables.product.prodname_code_quality_short %}, consider these costs:
32+
33+
* A per-active-committer fee for repositories where it's enabled
34+
* {% data variables.product.prodname_actions %} minutes for scans, unless you use self-hosted runners
35+
* {% data variables.product.prodname_ai_credits %} for {% data variables.product.prodname_copilot_short %}-powered fixes and AI-powered detections (no {% data variables.product.prodname_copilot_short %} license required)
36+
37+
For more information, see [AUTOTITLE](/billing/concepts/product-billing/github-code-quality).
38+
39+
## Next steps
40+
41+
To start using {% data variables.product.prodname_code_quality_short %}, see [AUTOTITLE](/code-security/how-tos/maintain-quality-code/enable-code-quality).

‎content/get-started/learning-about-github/githubs-plans.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ In addition to the features available with {% data variables.product.prodname_fr
8989
For more information, see [AUTOTITLE](/get-started/learning-about-github/about-github-advanced-security).
9090

9191
{% ifversion fpt or ghec %}
92-
* The option to purchase {% data variables.product.prodname_code_quality %}, which helps teams find and fix code quality and coverage issues. For more information, see [AUTOTITLE](/code-security/concepts/code-quality/code-quality).
92+
* The option to purchase {% data variables.product.prodname_code_quality %}, which helps teams find and fix code quality and coverage issues. For more information, see [AUTOTITLE](/get-started/learning-about-github/about-github-code-quality).
9393
{% endif %}
9494

9595
* Advanced tools and insights in private repositories:

‎content/get-started/learning-about-github/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ children:
1414
- /types-of-github-accounts
1515
- /access-permissions-on-github
1616
- /about-github-advanced-security
17+
- /about-github-code-quality
1718
- /faq-about-changes-to-githubs-plans
1819
- /github-glossary
1920
---

0 commit comments

Comments
 (0)