GeezerVison is showing docs.github.com — Improve code quality at scale with GitHub - GitHub Docs
Improve code quality at scale with GitHub
Inconsistent code quality slows every team down and adds risk you can't easily see. GitHub Code Quality catches issues before they merge and reports on code health across your organization. Follow this adoption path to evaluate the feature, run a pilot, prove its value, and roll it out at scale.
- 1
Phase 1: Evaluate and build your business case
3 Articles1-2 hoursEvaluate Code Quality alongside other code quality tools to determine whether it meets your organization's needs and build a business case. Review its use cases, supported languages, quality findings, and code coverage reporting. Learn how usage is billed and which cost controls are available before you plan your budget.
- 1GitHub Code Quality
- 2GitHub Code Quality billing
- 3Viewing and managing GitHub Code Quality costs
- 2
Phase 2: Plan your pilot
2 Articles2-4 hoursSelect a small, active group of repositories for your pilot and decide how you'll measure success. Identify the teams and repository owners who will provide feedback, prepare them for the findings they'll see on pull requests, and plan how you'll communicate remediation options, gather feedback, and monitor costs during the pilot.
- 1Code Quality enablement across organizations and enterprises
- 2Preventing code quality issues from reaching your default branch
- 3
Phase 3: Launch your pilot
4 Articles1-2 hoursAllow Code Quality for your enterprise, then enable it for your pilot repositories. Configure thresholds for Code Quality findings and code coverage. Start the ruleset in evaluate mode to see which pull requests would be blocked, adjust the thresholds based on the results, then enable enforcement.
- 1Allowing use of GitHub Code Quality in your enterprise
- 2Enabling GitHub Code Quality
- 3Setting code quality thresholds for pull requests
- 4Setting code coverage thresholds for pull requests
- 4
Phase 4: Assess the pilot and decide
4 Articles1-2 weeksCompare the pilot results with the success measures you defined. Review code health at the repository and organization level, monitor costs, and gather feedback from developers. Use what you learn to decide whether to expand, adjust, or stop the rollout.
- 1Exploring GitHub Code Quality results in your organization
- 2Interpreting the code quality results for your repository
- 3Viewing and managing GitHub Code Quality costs
- 4Disabling GitHub Code Quality
- 5
Phase 5: Scale and optimize
3 ArticlesOngoingExpand Code Quality to more repositories based on what you learned from the pilot. As you expand, adjust organization-level enablement and enforcement, and continue to monitor code health, license usage, GitHub Actions minutes, and GitHub AI Credits usage.
- 1Rolling out GitHub Code Quality at scale
- 2Exploring GitHub Code Quality results in your organization
- 3Viewing and managing GitHub Code Quality costs