{"meta":{"title":"Quickstart for GitHub Code Quality","intro":"Review code quality findings, generate a Copilot Autofix, and merge a pull request to improve reliability and maintainability with GitHub Code Quality.","product":"Security and code quality","breadcrumbs":[{"href":"/en/code-security","title":"Security and code quality"},{"href":"/en/code-security/tutorials","title":"Tutorials"},{"href":"/en/code-security/tutorials/improve-code-quality","title":"Improve code quality"},{"href":"/en/code-security/tutorials/improve-code-quality/quickstart","title":"Quickstart"}],"documentType":"article"},"body":"# Quickstart for GitHub Code Quality\n\nReview code quality findings, generate a Copilot Autofix, and merge a pull request to improve reliability and maintainability with GitHub Code Quality.\n\n## Introduction\n\nGitHub Code Quality (public preview) helps keep your code reliable and maintainable by surfacing code quality findings in pull requests and on your default branch.\n\nIn this tutorial, you’ll learn how to identify and fix a code quality finding on your default branch, helping to improve your repository’s code health.\n\n### Prerequisites\n\n* GitHub Code Quality must be enabled for your repository and you must have code in a supported language. See [Enabling GitHub Code Quality](/en/code-security/code-quality/how-tos/enable-code-quality).\n* If you're enabling GitHub Code Quality for the first time, ensure you've waited a few minutes after enablement for a full CodeQL scan of the default branch to complete.\n\n## Review scan results for your default branch\n\nIn your repository, go to the ** Security and quality** tab, click ** Code quality** in the left sidebar, then click **Standard findings** to open the repository dashboard.\n\nHere you'll see:\n\n* Ratings for the **Reliability** and **Maintainability** of your codebase, which help you understand your code health at a glance.\n* A **results list** of all the quality issues detected by a CodeQL-powered analysis on your default branch, which are grouped by rule and language.\n\n \n\n## Identify a high-impact finding\n\nUse the **dashboard filters** to identify a high severity level finding (\"Error\" or \"Warning\").\n\nResolving these will have the biggest impact on your repository's ratings.\n\n\n\n### Inspect the details of the finding\n\nClick the rule name itself to see a detailed view of the files and lines of code affected by that rule.\n\n\n\nOnce you're in the detailed view, click **Show more** to gather context and understand the results.\n\n\n\n## Generate a Copilot Autofix\n\nTo the right of a highlighted finding, click ** Generate fix**.\n\n\n\nReview the suggested fix, then click **Open pull request**.\n\n### Merge the fix\n\nCarefully review the draft pull request. If you're satisfied with the proposed changes, and all checks and tests are passing, go ahead and merge the pull request.\n\n## Observe the metrics change\n\nReturn to the Code Quality dashboard (** Security and quality** tab, then ** Code quality**, then **Standard findings**).\n\nWait a few minutes for the next scan to complete — Code Quality scans automatically re-run after every push to the default branch.\n\nObserve the change in metrics at the top of the dashboard:\n\n* The **number of findings** for \"Reliability\" or \"Maintainability\" should have decreased.\n* Your **ratings** for \"Reliability\" or \"Maintainability\" may have improved, if your fix addressed a number of high-impact findings.\n\n To understand more about how the ratings are calculated, see [Metrics and ratings reference](/en/code-security/code-quality/reference/metrics-and-ratings).\n\n## Conclusion\n\nYou've successfully used Code Quality and Copilot Autofix to improve your repository's code health!\n\nHealthy code is easier to understand, maintain, and extend, and remediating code quality issues makes your codebase more reliable, compliant, and accelerates future development.\n\n## Next steps\n\n* Learn how GitHub Code Quality works on pull requests to prevent code quality issues from reaching your default branch. See [Fixing code quality findings before merging your pull request](/en/code-security/code-quality/tutorials/fix-findings-in-prs).\n* Provide feedback on GitHub Code Quality in the [community discussion](https://github.com/orgs/community/discussions/177488)."}