在 GitHub 中使用 Amazon Q 开发者版进行代码审查 - Amazon Q 开发者版
先决条件为 GitHub 拉取请求启动代码审查在 GitHub 拉取请求中启动代码审查

在 GitHub 中使用 Amazon Q 开发者版进行代码审查

注意

GitHub 版 Amazon Q 开发者版目前处于预览发布阶段，功能可能会发生变更。

Amazon Q 开发者版支持在 GitHub 内进行自动化代码审查。当您创建新的拉取请求或重新打开已关闭的拉取请求时，Amazon Q 开发者版会自动执行代码审查，并针对代码质量、潜在问题及高严重性问题提供反馈。每次审查都会生成一份代码审查摘要，其中按主题分类列出发现的问题。Amazon Q 开发者版还会为已识别的问题生成修复方案，您可查看并选择是否将其提交到拉取请求中。在拉取请求的评论中，您可以使用 /q 命令提问，就代码审查发现的问题进行交互。现有拉取请求内后续提交的代码不会触发自动审查。

您也可以在拉取请求中使用 /q review 斜杠命令启动代码审查。该斜杠命令可添加到新的拉取请求评论中，针对拉取请求当前状态（包括所有评论和新提交）启动新的代码审查。有关更多信息，请参阅在 GitHub 拉取请求中启动代码审查。

您每月可使用 Amazon Q 开发者版审查有限行数的代码。您可随时将 Amazon Q 开发者版应用程序安装与 AWS 账户绑定注册，以提高免费使用限额。有关更多信息，请参阅在 Amazon Q 开发者版控制台中提高使用限额并配置的详细信息。

注意

若此前已禁用代码审查功能，需先在 Amazon Q 开发者版控制台中启用该功能，才能在 GitHub 中使用相关标签。有关更多信息，请参阅在 GitHub 中编辑 Amazon Q 开发者版功能。

先决条件

要使用 Amazon Q 开发者版启动代码审查，您需要具备目标 GitHub 存储库的相应权限。支持的存储库角色为“写入”权限、“维护”权限或“管理员”权限。拥有“读取”权限或“分类”权限的用户，以及无权限的成员，无法使用 Amazon Q 开发者版启动代码审查。

拥有“分类”权限的 GitHub 用户仍可审查存储库中的拉取请求。对于公共存储库，任何用户（无论角色如何）均可审查拉取请求。

有关更多信息，请参阅《GitHub 文档》中的组织的存储库角色和预定义组织角色介绍。

为 GitHub 拉取请求启动代码审查

当您打开新的拉取请求或重新打开之前关闭的拉取请求时，Amazon Q 开发者版会自动运行代码审查，并针对代码质量、潜在问题及关键问题提供反馈。

要使用 Amazon Q 开发者版进行代码审查并应用修复方案，请执行以下步骤：

开始审查前，您可以在 project-root/.amazonq/rules 目录下的简单 Markdown 文件中定义自定义编码标准，从而自定义代码质量审查准则。Amazon Q 会自动遵循这些准则，确保在整个项目中提供一致的代码质量。有关更多信息，请参阅在第三方平台中为 Amazon Q 开发者版创建项目规则。

  1. 如有需要，可使用您的 GitHub 凭证登录 GitHub 账户。

  2. 导航至您的 GitHub 组织，然后转至您希望使用 Amazon Q 开发者版进行代码审查的存储库。

  3. 为源代码的变更创建新的拉取请求。有关更多信息，请参阅《GitHub 文档》中的创建拉取请求。

    创建新拉取请求后，Amazon Q 开发者版会自动开始代码审查以发现潜在问题。审查完成后，Amazon Q 开发者版会生成一份代码审查摘要。每个发现的问题会以主题评论的形式显示在摘要下方，同时附带可提交到拉取请求的建议修复方案。

  4. （可选）就发现的具体问题提问。在拉取请求页面中，导航至添加评论，在评论文本输入字段中输入 /q 并附上您的问题（例如：“/q explain the importance of this finding”）。

  5. 查看 Amazon Q 开发者版提出的代码更改建议，选择提交建议，然后选择提交更改以更新拉取请求。

  6. 如果您对建议的代码修复方案感到满意，可合并拉取请求，应用 Amazon Q 开发者版建议的代码更改。有关更多信息，请参阅《GitHub 文档》中的合并拉取请求。

在 GitHub 拉取请求中启动代码审查

在 Amazon Q 开发者版针对新创建或重新打开的 GitHub 拉取请求完成自动审查后，您可以使用 /q review 斜杠命令启动额外的代码审查，对代码进行迭代优化。此次审查将针对拉取请求的完整差异内容进行。

注意

只能在拉取请求中针对新评论启动代码审查。/q review 斜杠命令在现有评论线程中无效。

要在拉取请求中使用启动代码审查，请执行以下步骤：

  1. 如有需要，可使用您的 GitHub 凭证登录 GitHub 账户。

  2. 导航至您的 GitHub 组织，然后转至您希望使用 Amazon Q 开发者版进行代码审查的拉取请求。有关更多信息，请参阅关于拉取请求。

  3. 在“拉取请求”页面中，导航至添加评论区域，在评论文本输入字段中输入 /q review。

  4. 选择评论以启动代码审查。

    Amazon Q 开发者版可能需要几分钟时间完成拉取请求代码的分析工作。分析完成后，Amazon Q 开发者版会生成一份代码审查摘要。每个发现的问题会以主题评论的形式显示在摘要下方，同时附带可选择提交以更新拉取请求的建议更改。

  5. （可选）就发现的具体问题提问。在拉取请求页面中，导航至添加评论，在评论文本输入字段中输入 /q 并附上您的问题（例如：“/q explain the importance of this finding”）。

  6. 如果您对建议的代码修复方案感到满意，可合并拉取请求，应用 Amazon Q 开发者版建议的代码更改。有关更多信息，请参阅《GitHub 文档》中的合并拉取请求。