{"meta":{"title":"GitHub 代码质量快速入门","intro":"检查代码质量结果，生成 Copilot自动修复，并将拉取请求与 GitHub Code Quality合并，以提高可靠性和可维护性。","product":"安全性和代码质量","breadcrumbs":[{"href":"/zh/code-security","title":"安全性和代码质量"},{"href":"/zh/code-security/tutorials","title":"Tutorials"},{"href":"/zh/code-security/tutorials/improve-code-quality","title":"提高代码质量"},{"href":"/zh/code-security/tutorials/improve-code-quality/quickstart","title":"快速入门"}],"documentType":"article"},"body":"# GitHub 代码质量快速入门\n\n检查代码质量结果，生成 Copilot自动修复，并将拉取请求与 GitHub Code Quality合并，以提高可靠性和可维护性。\n\n## 介绍\n\n```\n          GitHub Code Quality (公共预览版) 通过在拉取请求和默认分支中显示代码质量结果，帮助保持代码的可靠性和可维护性。\n```\n\n本教程介绍如何识别和修复默认分支上的代码质量查找，帮助改进存储库的代码运行状况。\n\n### 先决条件\n\n* GitHub Code Quality 必须为您的存储库启用，并且您的存储库中必须包含支持的语言的代码。 请参阅“[启用 GitHub Code Quality](/zh/code-security/code-quality/how-tos/enable-code-quality)”。\n* 如果您是首次启用 GitHub Code Quality ，请在启用后等待几分钟，以确保默认分支的 CodeQL 扫描能够完全完成。\n\n## 查看默认分支的扫描结果\n\n在存储库中，转到 **<svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon octicon-shield\" aria-label=\"shield\" role=\"img\"><path d=\"M7.467.133a1.748 1.748 0 0 1 1.066 0l5.25 1.68A1.75 1.75 0 0 1 15 3.48V7c0 1.566-.32 3.182-1.303 4.682-.983 1.498-2.585 2.813-5.032 3.855a1.697 1.697 0 0 1-1.33 0c-2.447-1.042-4.049-2.357-5.032-3.855C1.32 10.182 1 8.566 1 7V3.48a1.75 1.75 0 0 1 1.217-1.667Zm.61 1.429a.25.25 0 0 0-.153 0l-5.25 1.68a.25.25 0 0 0-.174.238V7c0 1.358.275 2.666 1.057 3.86.784 1.194 2.121 2.34 4.366 3.297a.196.196 0 0 0 .154 0c2.245-.956 3.582-2.104 4.366-3.298C13.225 9.666 13.5 8.36 13.5 7V3.48a.251.251 0 0 0-.174-.237l-5.25-1.68ZM8.75 4.75v3a.75.75 0 0 1-1.5 0v-3a.75.75 0 0 1 1.5 0ZM9 10.5a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg> Security and quality** 选项卡，单击 **<svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon octicon-code-review\" aria-label=\"code review\" role=\"img\"><path d=\"M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v8.5A1.75 1.75 0 0 1 14.25 13H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 14.543V13H1.75A1.75 1.75 0 0 1 0 11.25v-8.5C0 1.784.784 1 1.75 1ZM1.5 2.75v8.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-8.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Zm5.28 1.72a.75.75 0 0 1 0 1.06L5.31 7l1.47 1.47a.751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018l-2-2a.75.75 0 0 1 0-1.06l2-2a.75.75 0 0 1 1.06 0Zm2.44 0a.75.75 0 0 1 1.06 0l2 2a.75.75 0 0 1 0 1.06l-2 2a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042L10.69 7 9.22 5.53a.75.75 0 0 1 0-1.06Z\"></path></svg>代码质量** 左侧栏中，然后单击 **常规发现** 以打开存储库仪表板。\n\n你将在此处看到：\n\n* 代码库**可靠性和\\*\\*\\*\\*可维护性的**分级，可帮助你一目了然地了解代码运行状况。\n* 默认分支上由 CodeQL 支持的分析检测到的所有质量问题的**结果列表**，按规则和语言分组。\n\n  ![Code Quality 的“常规发现”视图中代码质量评级的屏幕截图。](/assets/images/help/code-quality/all-findings-overview-repo.png)\n\n## 确定影响重大的发现\n\n使用 **仪表板筛选器** 来识别高严重性级别的问题（“错误”或“警告”）。\n\n解决这些问题将对存储库的评级产生最大的影响。\n\n![“常规发现”视图的仪表板筛选器屏幕截图。](/assets/images/help/code-quality/standard-findings-filters.png)\n\n### 查看发现的详细信息\n\n单击规则名称本身可查看受该规则影响的文件和代码行的详细视图。\n\n![“常规发现”视图中某条规则的屏幕截图。 规则名称以深橙色突出显示。](/assets/images/help/code-quality/click-rule-name.png)\n\n进入详细视图后，单击“ **显示更多** ”以收集上下文并了解结果。\n\n![“已覆盖属性”规则发现截图。 文本“显示更多”以深橙色突出显示。](/assets/images/help/code-quality/click-show-more.png)\n\n## 生成 Copilot自动修复\n\n在突出显示的发现右侧，单击“**<svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon octicon-copilot\" aria-label=\"copilot\" role=\"img\"><path d=\"M7.998 15.035c-4.562 0-7.873-2.914-7.998-3.749V9.338c.085-.628.677-1.686 1.588-2.065.013-.07.024-.143.036-.218.029-.183.06-.384.126-.612-.201-.508-.254-1.084-.254-1.656 0-.87.128-1.769.693-2.484.579-.733 1.494-1.124 2.724-1.261 1.206-.134 2.262.034 2.944.765.05.053.096.108.139.165.044-.057.094-.112.143-.165.682-.731 1.738-.899 2.944-.765 1.23.137 2.145.528 2.724 1.261.566.715.693 1.614.693 2.484 0 .572-.053 1.148-.254 1.656.066.228.098.429.126.612.012.076.024.148.037.218.924.385 1.522 1.471 1.591 2.095v1.872c0 .766-3.351 3.795-8.002 3.795Zm0-1.485c2.28 0 4.584-1.11 5.002-1.433V7.862l-.023-.116c-.49.21-1.075.291-1.727.291-1.146 0-2.059-.327-2.71-.991A3.222 3.222 0 0 1 8 6.303a3.24 3.24 0 0 1-.544.743c-.65.664-1.563.991-2.71.991-.652 0-1.236-.081-1.727-.291l-.023.116v4.255c.419.323 2.722 1.433 5.002 1.433ZM6.762 2.83c-.193-.206-.637-.413-1.682-.297-1.019.113-1.479.404-1.713.7-.247.312-.369.789-.369 1.554 0 .793.129 1.171.308 1.371.162.181.519.379 1.442.379.853 0 1.339-.235 1.638-.54.315-.322.527-.827.617-1.553.117-.935-.037-1.395-.241-1.614Zm4.155-.297c-1.044-.116-1.488.091-1.681.297-.204.219-.359.679-.242 1.614.091.726.303 1.231.618 1.553.299.305.784.54 1.638.54.922 0 1.28-.198 1.442-.379.179-.2.308-.578.308-1.371 0-.765-.123-1.242-.37-1.554-.233-.296-.693-.587-1.713-.7Z\"></path><path d=\"M6.25 9.037a.75.75 0 0 1 .75.75v1.501a.75.75 0 0 1-1.5 0V9.787a.75.75 0 0 1 .75-.75Zm4.25.75v1.501a.75.75 0 0 1-1.5 0V9.787a.75.75 0 0 1 1.5 0Z\"></path></svg> 生成修复**”。\n\n![“生成修补程序”按钮的屏幕截图。](/assets/images/help/code-quality/generate-fix.png)\n\n查看建议的更改，然后单击“ **打开拉取请求**”。\n\n### 合并修复\n\n仔细审查拉取请求草稿。 如果对提议的更改满意，且所有检查和测试均通过，则合并拉取请求。\n\n## 观察指标更改\n\n返回到 Code Quality 仪表板（**<svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon octicon-shield\" aria-label=\"shield\" role=\"img\"><path d=\"M7.467.133a1.748 1.748 0 0 1 1.066 0l5.25 1.68A1.75 1.75 0 0 1 15 3.48V7c0 1.566-.32 3.182-1.303 4.682-.983 1.498-2.585 2.813-5.032 3.855a1.697 1.697 0 0 1-1.33 0c-2.447-1.042-4.049-2.357-5.032-3.855C1.32 10.182 1 8.566 1 7V3.48a1.75 1.75 0 0 1 1.217-1.667Zm.61 1.429a.25.25 0 0 0-.153 0l-5.25 1.68a.25.25 0 0 0-.174.238V7c0 1.358.275 2.666 1.057 3.86.784 1.194 2.121 2.34 4.366 3.297a.196.196 0 0 0 .154 0c2.245-.956 3.582-2.104 4.366-3.298C13.225 9.666 13.5 8.36 13.5 7V3.48a.251.251 0 0 0-.174-.237l-5.25-1.68ZM8.75 4.75v3a.75.75 0 0 1-1.5 0v-3a.75.75 0 0 1 1.5 0ZM9 10.5a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg> Security and quality** 选项卡，然后 **<svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon octicon-code-review\" aria-label=\"code review\" role=\"img\"><path d=\"M1.75 1h12.5c.966 0 1.75.784 1.75 1.75v8.5A1.75 1.75 0 0 1 14.25 13H8.061l-2.574 2.573A1.458 1.458 0 0 1 3 14.543V13H1.75A1.75 1.75 0 0 1 0 11.25v-8.5C0 1.784.784 1 1.75 1ZM1.5 2.75v8.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-8.5a.25.25 0 0 0-.25-.25H1.75a.25.25 0 0 0-.25.25Zm5.28 1.72a.75.75 0 0 1 0 1.06L5.31 7l1.47 1.47a.751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018l-2-2a.75.75 0 0 1 0-1.06l2-2a.75.75 0 0 1 1.06 0Zm2.44 0a.75.75 0 0 1 1.06 0l2 2a.75.75 0 0 1 0 1.06l-2 2a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042L10.69 7 9.22 5.53a.75.75 0 0 1 0-1.06Z\"></path></svg>代码质量**，然后 **常规发现**）。\n\n等待几分钟，等待下一次扫描完成 — Code Quality 每次推送到默认分支后，扫描会自动重新运行。\n\n观察仪表板顶部指标的变化：\n\n* “可靠性”或“可维护性”的**发现数量**应已减少。\n* 如果你的修补程序解决了许多影响重大的发现，则“可靠性”或“可维护性” **的评级** 可能会有所改善。\n\n  若要详细了解如何计算分级，请参阅 [指标和分级参考](/zh/code-security/code-quality/reference/metrics-and-ratings)。\n\n## 结论\n\n已成功使用 Code Quality 和 Copilot自动修复 改进存储库的代码运行状况！\n\n正常的代码更易于理解、维护和扩展，并修正代码质量问题，使代码库更加可靠、合规并加快未来开发。\n\n## 后续步骤\n\n* 了解 GitHub Code Quality 如何处理拉取请求，以防止代码质量问题到达默认分支。 请参阅“[在合并拉取请求之前修复代码质量问题](/zh/code-security/code-quality/tutorials/fix-findings-in-prs)”。\n* 在<c1>社区讨论</c1>中提供关于<c0>的反馈。"}