本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
# GitHub 版 Amazon Q 开发者版（预览版）
**注意**
GitHub 版 Amazon Q 开发者版目前处于预览发布阶段，功能可能会发生变更。
通过 [GitHub 版或 GitHub 企业云版 Amazon Q 开发者版](https://github.com/marketplace/amazon-q-developer)，您可以在软件开发工作流中利用 Amazon Q 开发者版的功能。借助专业的开发代理，您可以实施新想法，查看代码中是否存在质量问题，并通过单元测试来解决漏洞。代理完成任务后，您可以提供反馈，代理会基于之前的解决方案进行迭代优化。有关更多信息，请参阅 [Amazon Q 开发者版代理](#github-agents)。
您可以通过 [https://github.com/marketplace/amazon-q-developer](https://github.com/marketplace/amazon-q-developer) 访问 Amazon Q 开发者版集成，并授权其访问您所在组织的存储库。要开始使用 GitHub 版 Amazon Q 开发者版，请参阅[快速入门：安装、在 GitHub 中使用功能及提高使用限制](github-quickstart.md)。
**重要**
要安装 Amazon Q 开发者版应用程序并授权其访问 GitHub 存储库，您必须满足 GitHub 组织的相关要求。有关更多信息，请参阅《GitHub 文档》**中的[安装 GitHub 应用程序的要求](https://docs.github.com/en/enterprise-cloud@latest/apps/using-github-apps/installing-a-github-app-from-a-third-party#requirements-to-install-a-github-app)和[组织中的角色](https://docs.github.com/en/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)。
**注意**
Amazon Q 开发者版与 GitHub 的集成会在美国境内处理数据。有关更多信息，请参阅 [Amazon Q 开发者版中的跨区域处理](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/cross-region-processing.html)。
**注意**
适用于 GitHub 的 Amazon Q 开发者版（预览版）目前不会使用您的内容来改进服务。如果我们将来启用此功能，我们将向您提供充分的通知以及供您不选择此类用途的方式。
**Topics**
+ [安装 Amazon Q 开发者版应用程序并授权访问](#github-concepts-set-up)
+ [Amazon Q 开发者版代理](#github-agents)
+ [注册应用程序安装](#github-concepts-register-app-install)
+ [在中 GitHub 使用浏览器扩展程序](#github-concepts-extensions)
+ [在 GitHub 问题和拉取请求中使用斜杠命令](#github-slash-commands)
+ [快速入门：安装、在 GitHub 中使用功能及提高使用限制](github-quickstart.md)
+ [在 GitHub 中使用 Amazon Q 开发者版开发功能并迭代](github-feature-development.md)
+ [在 GitHub 中使用 Amazon Q 开发者版进行代码审查](github-code-reviews.md)
+ [在 Amazon Q 开发者版控制台中提高使用限额并配置的详细信息](github-register-app-install.md)
+ [配置已注册的安装详情](github-configuration.md)
+ [GitHub 版 Amazon Q 开发者版故障排查](github-troubleshooting.md)
## 安装 Amazon Q 开发者版应用程序并授权访问
作为GitHub组织管理员，您可以免费安装和配置 Amazon Q De [https://github.com/apps/amazon-q-developer](https://github.com/apps/amazon-q-developer)veloper 应用程序，而无需设置 AWS 账户即可开始使用。在安装过程中，您可以选择向该应用程序授予对 GitHub 组织中所有或选定存储库的访问权限。完成安装和授权后，您就能在 GitHub 中免费使用 Amazon Q 开发者版的功能。若要提升免费使用额度，可在 [Amazon Q 开发者版控制台](https://us-east-1.console.aws.amazon.com/amazonq/developer/home#/github)中注册该应用安装。有关更多信息，请参阅 [快速入门：安装、在 GitHub 中使用功能及提高使用限制](github-quickstart.md)。
**重要**
要安装 Amazon Q 开发者版应用程序并授权其访问 GitHub 存储库，您必须满足 GitHub 组织的相关要求。有关更多信息，请参阅《GitHub 文档》**中的[安装 GitHub 应用程序的要求](https://docs.github.com/en/enterprise-cloud@latest/apps/using-github-apps/installing-a-github-app-from-a-third-party#requirements-to-install-a-github-app)和[组织中的角色](https://docs.github.com/en/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)。
**注意**
如果您的 GitHub 企业组织已启用 IP 允许列表，则必须在 GitHub 应用程序中确认允许的 IP 地址。您也可以选择将这些 IP 地址自动添加到您的允许列表中。有关更多信息，请参阅《GitHub 文档》**中的[允许 GitHub 应用程序访问](https://docs.github.com/en/enterprise-cloud@latest/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization#allowing-access-by-github-apps)和[启用允许的 IP 地址](https://docs.github.com/en/enterprise-cloud@latest/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization#enabling-allowed-ip-addresses)。
以下是用于访问您 GitHub 资源的 IP 地址：
```
34.228.181.128
44.219.176.187
54.226.244.221
```
## Amazon Q 开发者版代理
Amazon Q Developer 代理在整个软件开发生命周期中提供支持，从编码、测试和部署到故障排除。
+ **Amazon Q 开发代理**：创建问题并添加“功能开发”标签后，Amazon Q 开发者版会自动实现您的新功能和错误修复。Amazon Q 开发者版会创建一个包含代码更改及更改摘要的拉取请求。除应用标签外，您也可以在问题评论中使用 `/q dev` 斜杠命令来启动功能开发。有关更多信息，请参阅 [在 GitHub 中使用 Amazon Q 开发者版开发功能并迭代](github-feature-development.md)。
+ **Amazon Q 代码审查代理**：当新拉取请求创建或已关闭的拉取请求重新打开时，Amazon Q 开发者版会自动执行代码审查，并针对代码质量、潜在问题及安全隐患提供反馈。Amazon Q 开发者版还会为已识别的问题生成修复方案，您可查看并选择是否将其提交到拉取请求中。代码审查结果包含一份审查摘要，其中按主题分类列出问题。您可在拉取请求的评论中使用 `/q` 命令与 Amazon Q 开发者版交互，就代码审查中发现的问题提问。
现有拉取请求内后续提交的代码不会触发自动审查。您可在拉取请求中使用 `/q review` 斜杠命令启动额外的代码审查。有关更多信息，请参阅 [在 GitHub 中使用 Amazon Q 开发者版进行代码审查](github-code-reviews.md)。
**重要**
Amazon Q Developer 应用程序会尝试在您授权访问的GitHub存储库中自动创建 **Amazon Q 开发代理**标签。如果标签不是自动创建的，或者是无意中删除的，则可以在中手动创建GitHub。必须将该标签命名为 **Amazon Q 开发代理**，才能将其识别为 Amazon Q 开发者标签并进行处理。有关更多信息，请参阅《GitHub 文档》**中的[创建标签](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels#creating-a-label)。
## 注册应用程序安装
Amazon Q 开发者版与 GitHub 的集成可免费使用，无需先设置 AWS 账户即可开始。每月为你提供的功能开发调用次数有限，而且每月用于代码审查的行数也很有限。若要提升免费使用额度，可将您的 Amazon Q 开发者版应用程序安装与 AWS 账户进行注册绑定。有关更多信息，请参阅 [在 Amazon Q 开发者版控制台中提高使用限额并配置的详细信息](github-register-app-install.md)。
**重要**
要在 Amazon Q 开发者版控制台中注册应用程序安装，您必须满足 GitHub 组织的相关要求。有关更多信息，请参阅*GitHub文档*中的[GitHub应用程序安装要求](https://docs.github.com/en/enterprise-cloud@latest/apps/using-github-apps/installing-a-github-app-from-a-third-party#requirements-to-install-a-github-app)[以及OAuth 应用程序和组织](https://docs.github.com/en/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps#oauth-apps-and-organizations)。
## 在中 GitHub 使用浏览器扩展程序
您可以在支持的浏览器中使用 Amazon Q Developer 扩展程序，在GitHub问题中快速添加用于功能开发的标签，而无需搜索标签菜单。
Amazon Q 开发者版扩展程序支持以下浏览器：
+ [Google Chrome](https://chromewebstore.google.com/detail/amazon-q-github-issue-hel/oefafjbablenakmhacfllkmpaeabnnfi)
+ [Mozilla Firefox](https://addons.mozilla.org/en-US/firefox/addon/amazon-q-github-issue-helper)
+ [Microsoft Edge](https://microsoftedge.microsoft.com/addons/detail/amazon-q-github-issue-helper/poghackjbfhejeppjaegbnblangjbmmc)
## 在 GitHub 问题和拉取请求中使用斜杠命令
您可以在 GitHub 问题或拉取请求的评论中使用斜杠命令，调用 Amazon Q 开发者版执行开发任务或提供支持。
+ `/q dev`：在 GitHub 问题中调用 Amazon Q 开发者版，自动实现新功能和错误修复。Amazon Q 开发者版会创建一个包含代码更改及更改摘要的拉取请求。
+ `/q review`：调用 Amazon Q 开发者版，在拉取请求创建或重新打开时自动执行代码审查。代码审查会针对代码质量、潜在问题及安全隐患提供反馈，同时给出建议修复方案，并生成按主题分类列出问题的审查摘要。在拉取请求评论中使用 `/q` 可与审查发现的问题进行交互。现有拉取请求后续提交的代码不会触发自动审查。
+ `/q help`：提供 GitHub 版 Amazon Q 开发者版的相关信息，包括斜杠命令、功能、自定义详情，以及指向《Amazon Q 开发者版指南》**中 [GitHub 版 Amazon Q 开发者版（预览版）](#amazon-q-for-github) 文档的链接。
# 快速入门：安装、在 GitHub 中使用功能及提高使用限制
**注意**
GitHub 版 Amazon Q 开发者版目前处于预览发布阶段，功能可能会发生变更。
本教程将逐步指导您完成以下任务：
1. 从 GitHub Marketplace 安装 Amazon Q 开发者版应用程序，并授予其对您存储库的访问权限。
1. 通过为功能开发添加标签或创建新的代码审查拉取请求，开始使用 Amazon Q Developer 来处理问题。或者，你可以在问题中使用斜杠命令来启动功能开发。还能在拉取请求中使用斜杠命令启动额外的代码审查。
1. （可选）使用您的 AWS 账户注册安装的 Amazon Q Developer 应用程序，以提高使用限制。
## 步骤 1：在 GitHub 中安装 Amazon Q 开发者版并授权访问
您可以GitHub免费使用 Amazon Q Developer，无需设置 AWS 账户即可开始使用。在 GitHub 中使用 Amazon Q 开发者版的第一步是从 [https://github.com/marketplace/amazon-q-developer](https://github.com/marketplace/amazon-q-developer) 安装该应用程序。在此过程中，您可以授予 Amazon Q 开发者版对 GitHub 中所有存储库或选定存储库的访问权限。
**重要**
要安装 Amazon Q 开发者版应用程序并授权其访问 GitHub 存储库，您必须满足 GitHub 组织的相关要求。有关更多信息，请参阅《GitHub 文档》**中的[安装 GitHub 应用程序的要求](https://docs.github.com/en/enterprise-cloud@latest/apps/using-github-apps/installing-a-github-app-from-a-third-party#requirements-to-install-a-github-app)和[组织中的角色](https://docs.github.com/en/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)。
**要安装 Amazon Q 开发者版并授权访问，请执行以下步骤**
1. 导航至 [GitHub 版 Amazon Q 开发者版应用程序](https://github.com/marketplace/amazon-q-developer)页面。
1. 如有需要，可使用您的 GitHub 凭证登录 [https://github.com/](https://github.com/) 账户。
1. 查看 Amazon Q 开发者版应用程序的概述和功能，然后选择**安装**。
1. 选择以下任一方式配置对 GitHub 存储库的访问权限：
1. 要提供对所有当前和未来存储库的访问权限，请选择**所有存储库**。
1. 要提供对特定存储库的访问权限，请选择**仅选定存储库**，选择**选择存储库**下拉菜单，然后选择您希望允许访问的存储库。
1. 选择**安装**，完成在 GitHub 中安装 Amazon Q 开发者版并授权其访问您存储库的操作。
在 GitHub 中完成应用程序安装和授权访问后，系统会将您重定向至 GitHub 中的 Amazon Q 开发者版概览页面。您可以导航至您的 GitHub 存储库，开始使用 Amazon Q 开发者版的功能。
**注意**
如果您的 GitHub 企业组织已启用 IP 允许列表，则必须在 GitHub 应用程序中确认允许的 IP 地址。您也可以选择将这些 IP 地址自动添加到您的允许列表中。有关更多信息，请参阅《GitHub 文档》**中的[允许 GitHub 应用程序访问](https://docs.github.com/en/enterprise-cloud@latest/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization#allowing-access-by-github-apps)和[启用允许的 IP 地址](https://docs.github.com/en/enterprise-cloud@latest/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization#enabling-allowed-ip-addresses)。
以下是用于访问您 GitHub 资源的 IP 地址：
```
34.228.181.128
44.219.176.187
54.226.244.221
```
## 步骤 2：在 GitHub 中使用 Amazon Q 开发者版功能
在中安装 Amazon Q Developer 应用程序GitHub并授权访问您的存储库后，您可以开始使用 Amazon Q Developer 代理在整个软件开发生命周期中获得支持，从编码、测试和部署到应用程序故障排除。有关更多信息，请参阅以下任一文档：
**重要**
Amazon Q Developer 应用程序会尝试在您授权访问的GitHub存储库中自动创建 **Amazon Q 开发代理**标签。如果标签不是自动创建的，或者是无意中删除的，则可以在中手动创建GitHub。必须将该标签命名为 **Amazon Q 开发代理**，才能将其识别为 Amazon Q 开发者标签并进行处理。有关更多信息，请参阅《GitHub 文档》**中的[创建标签](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels#creating-a-label)。
+ [在 GitHub 中使用 Amazon Q 开发者版开发功能并迭代](github-feature-development.md)
+ [在 GitHub 中使用 Amazon Q 开发者版进行代码审查](github-code-reviews.md)
## 步骤 3：提高免费使用限额并配置详细信息
您可以在 GitHub 中免费使用 Amazon Q 开发者版代理，无需先设置 AWS 账户即可开始。每月为你提供的功能开发和代码审查的调用次数有限。您可以随时通过使用您的 AWS 账户注册安装的 Amazon Q Developer 应用程序来增加免费使用量。注册后，您还可以配置相关详细信息，例如禁用代码审查、添加用于搜索和筛选的标签等。有关更多信息，请参阅 [在 Amazon Q 开发者版控制台中提高使用限额并配置的详细信息](github-register-app-install.md)。
**重要**
要在 Amazon Q 开发者版控制台中注册应用程序安装，您必须满足 GitHub 组织的相关要求。有关更多信息，请参阅*GitHub文档*中的[GitHub应用程序安装要求](https://docs.github.com/en/enterprise-cloud@latest/apps/using-github-apps/installing-a-github-app-from-a-third-party#requirements-to-install-a-github-app)[以及OAuth 应用程序和组织](https://docs.github.com/en/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps#oauth-apps-and-organizations)。
# 在 GitHub 中使用 Amazon Q 开发者版开发功能并迭代
**注意**
GitHub 版 Amazon Q 开发者版目前处于预览发布阶段，功能可能会发生变更。
在 GitHub 中，您可以使用 Amazon Q 开发者版自动实现新功能和漏洞修复，将任务从想法转化为完整的拉取请求，从而简化开发流程。当您为问题添加“功能开发”标签，或使用 `/q dev` 斜杠命令时，Amazon Q 开发者版会将该问题（包括标题、描述）及存储库代码作为上下文，生成新的代码修复方案并创建拉取请求。在拉取请求中，您可以提供反馈，Amazon Q 开发者版会基于反馈对建议代码进行迭代优化。
您每月可使用 Amazon Q 开发者版执行有限次数的功能开发。您可以随时通过使用您的 AWS 账户注册安装的 Amazon Q Developer 应用程序来增加免费使用量。有关更多信息，请参阅 [在 Amazon Q 开发者版控制台中提高使用限额并配置的详细信息](github-register-app-install.md)。
**重要**
Amazon Q Developer 应用程序会尝试在您授权访问的GitHub存储库中自动创建 **Amazon Q 开发代理**标签。如果标签不是自动创建的，或者是无意中删除的，则可以在中手动创建GitHub。必须将该标签命名为 **Amazon Q 开发代理**，才能将其识别为 Amazon Q 开发者标签并进行处理。有关更多信息，请参阅《GitHub 文档》**中的[创建标签](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels#creating-a-label)。
**要使用 Amazon Q 开发者版进行功能开发，请执行以下步骤**
1. 如有需要，可使用您的 GitHub 凭证登录 [https://github.com/](https://github.com/) 账户。
1. 导航至您的 GitHub 组织，然后进入您希望使用 Amazon Q 开发者版开发新功能的存储库。
1. 选择**问题**，然后创建新问题或选择现有问题。有关更多信息，请参阅《GitHub 文档》**中的[创建问题](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/creating-an-issue)。
1. 对于新问题，在**添加标题**文本输入框中，输入能为 Amazon Q 开发者版提供功能开发上下文的标题（例如：“创建图像识别应用程序”）。同时需包含问题描述，因其也会为功能开发提供上下文。
对于现有问题，您可以编辑问题标题和描述，为 Amazon Q 开发者版提供功能开发所需的上下文。有关更多信息，请参阅《GitHub 文档》**中的[编辑问题](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/editing-an-issue)。
1. 创建问题或配置现有问题时，可添加 Amazon Q 开发者版“功能开发”标签，或使用 `/q dev` 斜杠命令。请执行以下操作之一：
+ 要为问题添加标签，请执行以下操作之一：
+ 选择作为浏览器扩展程序提供的**分配给 Amazon Q** 下拉菜单，然后选择 **Amazon Q 开发代理**标签。
+ 在右侧菜单中选择**标签**，然后选择 **Amazon Q 开发代理**标签。
+ 要在评论中使用 `/q dev` 斜杠命令，请执行以下操作：
1. 在“问题”页面中，导航至**添加评论**区域，在评论文本输入字段中输入 `/q dev`。
1. 选择**评论**。
1. 对于新问题，选择**创建问题**，完成包含 Amazon Q 开发者版开发功能所需详情的问题创建。如果您配置的是现有问题，请确保保存更改。有关更多信息，请参阅《GitHub 文档》**中的[编辑问题](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/editing-an-issue)。
当 Amazon Q 开发者版完成功能开发的代码更改生成后，会在问题中添加评论并创建拉取请求。
1. 导航至 Amazon Q 开发者版留下的评论（例如：“`I finished the proposed code changes, and the pull request is ready for review: [PR link]`”），然后点击拉取请求链接。
您也可以导航至**拉取请求**选项卡，然后选择 Amazon Q 开发者版创建的拉取请求。
1. 选择**文件变更**选项卡，查看代码更改。
1. 如果您对建议的代码更改感到满意，可合并该拉取请求。有关更多信息，请参阅[合并拉取请求](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)。
您也可以审查该功能开发的拉取请求，并通过向 Amazon Q 开发者版提供反馈，对建议的代码更改进行迭代优化。
**要对 Amazon Q 开发者版功能开发代码进行迭代，请执行以下步骤**
1. 选择 Amazon Q 开发者版创建的拉取请求，然后选择**文件变更**选项卡，查看代码更改。
1. 或者，对于要提供反馈的特定代码行，请选择 **\$1** 以添加带有反馈的评论。
在对话中，您可以使用`/q`命令，然后使用自然语言进行指示（例如，`/q implement my suggestions`或`/q refactor this function for better performance`）。Amazon Q Developer 将在回复时附上一条评论，描述它将根据您的反馈做出的更改（例如，“我将根据反馈实施以下更改：...”）。实施完成后，Amazon Q Developer 将发布另一条评论来确认更改（例如，“我已实施了建议的更改。”），并附上指向生成的提交链接，您可以在其中查看更改。
1. 点击对话中提供的提交链接，查看 Amazon Q 开发者所做的更改。您可以根据需要使用`/q`命令继续提供其他反馈以进行进一步的迭代。
1. 如果您对更新后的代码更改满意，可合并拉取请求，或通过新反馈再次对代码进行迭代。有关更多信息，请参阅[合并拉取请求](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)。
# 在 GitHub 中使用 Amazon Q 开发者版进行代码审查
**注意**
GitHub 版 Amazon Q 开发者版目前处于预览发布阶段，功能可能会发生变更。
Amazon Q 开发者版支持在 GitHub 内进行自动化代码审查。当您创建新的拉取请求或重新打开已关闭的拉取请求时，Amazon Q 开发者版会自动执行代码审查，并针对代码质量、潜在问题及高严重性问题提供反馈。每次审查都会生成一份代码审查摘要，其中按主题分类列出发现的问题。Amazon Q 开发者版还会为已识别的问题生成修复方案，您可查看并选择是否将其提交到拉取请求中。在拉取请求的评论中，您可以使用 `/q` 命令提问，就代码审查发现的问题进行交互。现有拉取请求内后续提交的代码不会触发自动审查。
**注意**
Amazon Q 开发者控制台中的 “代码审查” 功能设置控制在创建或重新打开拉取请求时运行的自动代码审查。在拉取请求注释中使用`/q review`斜杠命令启动代码审查不受此设置的影响。
您也可以在拉取请求中使用 `/q review` 斜杠命令启动代码审查。该斜杠命令可添加到新的拉取请求评论中，针对拉取请求当前状态（包括所有评论和新提交）启动新的代码审查。有关更多信息，请参阅 [在 GitHub 拉取请求中启动代码审查](#github-code-reviews-in-pr)。
您每月可使用 Amazon Q 开发者版审查有限行数的代码。您可以随时通过使用您的 AWS 账户注册安装的 Amazon Q Developer 应用程序来增加免费使用量。有关更多信息，请参阅 [在 Amazon Q 开发者版控制台中提高使用限额并配置的详细信息](github-register-app-install.md)。
**注意**
若此前已禁用代码审查功能，需先在 [Amazon Q 开发者版控制台](https://us-east-1.console.aws.amazon.com/amazonq/developer/home#/github)中启用该功能，才能在 GitHub 中使用相关标签。有关更多信息，请参阅 [在 GitHub 中编辑 Amazon Q 开发者版功能](github-configuration.md#github-edit-features)。
## 先决条件
要使用 Amazon Q 开发者版启动代码审查，您需要具备目标 GitHub 存储库的相应权限。支持的存储库角色为“写入”权限、“维护”权限或“管理员”权限。拥有“读取”权限或“分类”权限的用户，以及无权限的成员，无法使用 Amazon Q 开发者版启动代码审查。
拥有“分类”权限的 GitHub 用户仍可审查存储库中的拉取请求。对于公共存储库，任何用户（无论角色如何）均可审查拉取请求。
有关更多信息，请参阅《GitHub 文档》**中的[组织的存储库角色](https://docs.github.com/en/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization#repository-roles-for-organizations)和[预定义组织角色介绍](https://docs.github.com/en/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#about-pre-defined-organization-roles)。
## 为 GitHub 拉取请求启动代码审查
当您打开新的拉取请求或重新打开之前关闭的拉取请求时，Amazon Q 开发者版会自动运行代码审查，并针对代码质量、潜在问题及关键问题提供反馈。
**要使用 Amazon Q 开发者版进行代码审查并应用修复方案，请执行以下步骤：**
开始审查前，您可以在 `project-root/.amazonq/rules` 目录下的简单 Markdown 文件中定义自定义编码标准，从而自定义代码质量审查准则。Amazon Q 会自动遵循这些准则，确保在整个项目中提供一致的代码质量。有关更多信息，请参阅 [在第三方平台中为 Amazon Q 开发者版创建项目规则](third-party-context-project-rules.md)。
1. 如有需要，可使用您的 GitHub 凭证登录 [https://github.com/](https://github.com/) 账户。
1. 导航至您的 GitHub 组织，然后转至您希望使用 Amazon Q 开发者版进行代码审查的存储库。
1. 为源代码的变更创建新的拉取请求。有关更多信息，请参阅《GitHub 文档》**中的[创建拉取请求](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)。
创建新拉取请求后，Amazon Q 开发者版会自动开始代码审查以发现潜在问题。审查完成后，Amazon Q 开发者版会生成一份代码审查摘要。每个发现的问题会以主题评论的形式显示在摘要下方，同时附带可提交到拉取请求的建议修复方案。
1. 要求代理实施更改并直接在拉取请求的源分支上创建提交。为此，您可以发布一条以自然语言开头的评论，`/q`然后是您的自然语言请求代理进行更改。
1. （可选）就发现的具体问题提问。在拉取请求页面中，导航至**添加评论**，在评论文本输入字段中输入 `/q` 并附上您的问题（例如：“`/q explain the importance of this finding`”）。
1. 查看 Amazon Q 开发者版提出的代码更改建议，选择**提交建议**，然后选择**提交更改**以更新拉取请求。
1. 如果您对建议的代码修复方案感到满意，可合并拉取请求，应用 Amazon Q 开发者版建议的代码更改。有关更多信息，请参阅《GitHub 文档》**中的[合并拉取请求](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)。
## 在 GitHub 拉取请求中启动代码审查
在 Amazon Q 开发者版针对新创建或重新打开的 GitHub 拉取请求完成自动审查后，您可以使用 `/q review` 斜杠命令启动额外的代码审查，对代码进行迭代优化。此次审查将针对拉取请求的完整差异内容进行。
**注意**
只能在拉取请求中针对新评论启动代码审查。`/q review` 斜杠命令在现有评论线程中无效。使用 `/q review` slash 命令启动代码审查不受 Amazon Q 开发者控制台中的 “代码审查” 功能设置的影响。
**要在拉取请求中使用启动代码审查，请执行以下步骤：**
1. 如有需要，可使用您的 GitHub 凭证登录 [https://github.com/](https://github.com/) 账户。
1. 导航至您的 GitHub 组织，然后转至您希望使用 Amazon Q 开发者版进行代码审查的拉取请求。有关更多信息，请参阅[关于拉取请求](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)。
1. 在“拉取请求”页面中，导航至**添加评论**区域，在评论文本输入字段中输入 `/q review`。
1. 选择**评论**以启动代码审查。
Amazon Q 开发者版可能需要几分钟时间完成拉取请求代码的分析工作。分析完成后，Amazon Q 开发者版会生成一份代码审查摘要。每个发现的问题会以主题评论的形式显示在摘要下方，同时附带可选择提交以更新拉取请求的建议更改。
1. （可选）就发现的具体问题提问。在拉取请求页面中，导航至**添加评论**，在评论文本输入字段中输入 `/q` 并附上您的问题（例如：“`/q explain the importance of this finding`”）。
1. 如果您对建议的代码修复方案感到满意，可合并拉取请求，应用 Amazon Q 开发者版建议的代码更改。有关更多信息，请参阅《GitHub 文档》**中的[合并拉取请求](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)。
# 在 Amazon Q 开发者版控制台中提高使用限额并配置的详细信息
**注意**
GitHub 版 Amazon Q 开发者版目前处于预览发布阶段，功能可能会发生变更。
您可以免费使用 Amazon Q Developer 代理，无需设置 AWS 账户即可开始使用。GitHub您每月获得的功能开发和代码审查功能的调用次数有限。您可以随时通过使用您的 AWS 账户注册安装的 Amazon Q Developer 应用程序来增加免费使用量。
默认情况下，当您安装应用程序GitHub时，将在中启用**代码审查**和**功能开发**功能。您可在注册时禁用其中任意功能。注册需要创建 Amazon Q 开发者版配置文件，以便从控制台管理这些功能。该配置文件会存储您的设置和代码建议自定义项。
**重要**
要在 Amazon Q 开发者版控制台中注册应用程序安装，您必须满足 GitHub 组织的相关要求。有关更多信息，请参阅*GitHub文档*中的[GitHub应用程序安装要求](https://docs.github.com/en/enterprise-cloud@latest/apps/using-github-apps/installing-a-github-app-from-a-third-party#requirements-to-install-a-github-app)[以及OAuth 应用程序和组织](https://docs.github.com/en/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps#oauth-apps-and-organizations)。
**要注册您的 Amazon Q 开发者版安装，请执行以下步骤**
1. 导航至 [Amazon Q 开发者版控制台](https://us-east-1.console.aws.amazon.com/amazonq/developer/home)。
1. 选择页面顶部的**启用 Q D** eveloper，然后按照提示启用 Kiro 和 Amazon Q Developer。
如果您之前启用了 Kiro 和 Amazon Q Developer，请跳至步骤 3。
1. 在导航窗格中，选择**中的 Amazon Q 开发人员GitHub**。
1. 选择**注册安装**，然后选择**授权**，系统会将您引导至 GitHub。
如果您此前已授权 Amazon Q 开发者版访问您的 GitHub 组织，系统会将您重定向回 Amazon Q 开发者版控制台。在这种情况下，请跳至步骤 7。
1. 使用您的 GitHub 凭证登录 GitHub 账户。如果您有多个账户，请选择您希望向其授予 Amazon Q 开发者版访问权限的账户。
1. 选择**授权 Amazon Q 开发者版**，授予其访问您 GitHub 账户的权限。授权完成后，系统会将您重定向回 Amazon Q 开发者版控制台。
1. 在**注册详细信息**下，输入您的 GitHub 详细信息，可选择配置“代码审查”功能，并添加标签。
1. 在**注册名称**文本输入框中，输入应用程序安装的名称。
1. （可选）在**组织名称（*可选*）**文本输入字段中，输入与该应用程序安装关联的组织名称。
1. （可选）在**功能**下，通过切换开关启用或禁用**代码审查**功能，完成该功能的配置。**功能开发**配置无法修改，默认情况下处于启用状态。
1. （可选）在 “**标签-可选**” 下，选择 “**添加新标签**” 以添加一个可以帮助搜索和筛选 AWS 资源的标签GitHub。
1. 选择 “**注册**” 以GitHub使用您的 AWS 帐户注册您的应用程序安装。
成功注册应用程序安装后，您可以查看注册详细信息。您仍然可以启用或禁用代码审查功能，也可以在以后添加标签。您也可以删除注册。有关更多信息，请参阅 [配置已注册的安装详情](github-configuration.md)。
# 配置已注册的安装详情
**注意**
GitHub 版 Amazon Q 开发者版目前处于预览发布阶段，功能可能会发生变更。
创建 Amazon Q 开发者版配置文件并注册 GitHub 中的应用安装后，您可在 Amazon Q 开发者版控制台中执行以下操作：
+ 启用或禁用“代码审查”。功能开发配置目前无法修改。
+ 查找浏览器扩展程序的链接，通过该扩展可在 GitHub 问题中快速添加 Amazon Q 开发者版功能标签。
+ 添加标签以搜索和筛选您的资源或跟踪 AWS 成本。
+ 删除 GitHub 应用安装的注册信息。
## 在 GitHub 中编辑 Amazon Q 开发者版功能
在 GitHub 中安装应用并授权其访问您的组织后，GitHub 中的 Amazon Q 开发者版的所有可用功能默认处于启用状态。如果您不再希望在 GitHub 中使用某一功能，可选择将其禁用。
**要在 GitHub 中启用或禁用 Amazon Q 开发者版功能，请执行以下步骤**
1. 导航至 [Amazon Q 开发者版控制台](https://us-east-1.console.aws.amazon.com/amazonq/developer/home#/github)。
1. 在导航窗格的 **GitHub 中的 Amazon Q 开发者版**下，选择**已注册的安装**。
1. 在**名称**列下，选择您希望启用或禁用功能的安装对应的注册名称。
1. 在**功能**下，选择**编辑**，配置功能的可用性。
1. 在弹出的对话框中，切换您希望启用或禁用的功能对应的开关，然后选择**保存**确认更改。
在 [Amazon Q 开发者版控制台](https://us-east-1.console.aws.amazon.com/amazonq/developer/home#/github)中启用或禁用功能后，变更会同步到 GitHub。禁用功能后，若尝试为问题分配 Amazon Q 开发者版标签，会触发错误。若禁用代码审查功能，新拉取请求中将不再自动执行代码审查。
## 安装浏览器扩展程序
您可以在任一受支持的浏览器中安装 Amazon Q 开发者版扩展程序。该扩展程序使您能够在GitHub问题中快速将功能开发任务分配给 Amazon Q Developer，而无需在标签菜单中进行搜索。
Amazon Q 开发者版扩展程序支持以下浏览器：
+ [Google Chrome](https://chromewebstore.google.com/detail/amazon-q-github-issue-hel/oefafjbablenakmhacfllkmpaeabnnfi)
+ [Mozilla Firefox](https://addons.mozilla.org/en-US/firefox/addon/amazon-q-github-issue-helper)
+ [Microsoft Edge](https://microsoftedge.microsoft.com/addons/detail/amazon-q-github-issue-helper/poghackjbfhejeppjaegbnblangjbmmc)
您也可在 [Amazon Q 开发者版控制台](https://us-east-1.console.aws.amazon.com/amazonq/developer/home#/github)的“已注册安装详情”页面中查看受支持的浏览器列表。
## 删除 Amazon Q 开发者版 GitHub 应用安装的注册信息
您可通过 Amazon Q 开发者版控制台，删除一个或多个 GitHub 应用安装的注册信息。永久删除注册后，与该注册关联的所有数据也会被删除，且此操作无法撤销。
**要删除 GitHub 应用安装，请执行以下步骤**
1. 导航至 [Amazon Q 开发者版控制台](https://us-east-1.console.aws.amazon.com/amazonq/developer/home#/github)。
1. 在导航窗格的 **GitHub 中的 Amazon Q 开发者版**下，选择**已注册的安装**。
1. 请执行以下操作之一：
+ 在**操作**列下，为您希望删除的安装选择**删除注册**。
+ 在**名称**列下，选择您希望删除的安装对应的注册名称，然后选择**删除**。
在**操作**列下，为您希望删除的已注册安装选择**删除注册**。
1. 在弹出的对话框中，查看删除注册的相关详情。
1. 在文本输入框中输入 **confirm**，然后选择**删除**确认更改。
删除 GitHub 应用安装后，您仍可选择注册新的安装。
# GitHub 版 Amazon Q 开发者版故障排查
若在使用 GitHub 版 Amazon Q 开发者版时遇到常见问题，可参考以下部分进行排查。
## 在有分支保护规则的存储库中，Amazon Q 开发者版无法生成拉取请求
**问题描述**：我的 GitHub 存储库配置了分支保护规则，导致 Amazon Q 开发者版无法在该存储库中创建拉取请求。
**解决方案**：分支保护规则会阻止 Amazon Q 开发者版创建分支，进而无法创建拉取请求。若要在有分支保护规则的存储库中使用 GitHub 版 Amazon Q 开发者版，需将 Amazon Q 开发者版应用添加到允许列表中。
**要将 Amazon Q 开发者版应用程序添加到允许列表，请执行以下步骤**
1. 如有需要，可使用您的 GitHub 凭证登录 [https://github.com/](https://github.com/) 账户。
1. 导航至您的 GitHub 组织，然后进入您希望将 GitHub 版 Amazon Q 开发者版应用加入允许列表的存储库。
1. 选择**设置**，然后在导航窗格中选择**分支**。
1. 在**分支保护规则**下，选择**编辑**以修改分支保护规则。
1. 选择**限制创建匹配分支的推送**，然后搜索 GitHub 版 Amazon Q 开发者版应用程序。
1. 选择**保存更改**，允许 Amazon Q 开发者版为带有其标签的问题创建拉取请求。
要了解更多在 GitHub 中修改分支保护规则的信息，请参阅[创建分支保护规则](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule#creating-a-branch-protection-rule)。
## GitHub 问题中缺少 Amazon Q 开发者版标签
**问题**：我看不到GitHub问题中的 **Amazon Q 开发代理**标签。
**解决方案**：如果您在安装 Amazon Q Developer for GitHub 应用程序时未自动创建标签，或者标签被无意中删除，则可以在中手动创建标签GitHub。必须将该标签命名为 **Amazon Q 开发代理**，才能将其识别为 Amazon Q 开发者标签并进行处理。有关更多信息，请参阅《GitHub 文档》**中的[创建标签](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels#creating-a-label)。
## Amazon Q 开发者版无法为 GitHub 问题生成代码
**问题描述**：我创建了一个 GitHub 问题并调用 Amazon Q 开发者版执行任务，但收到以下一系列关于技术故障的提示消息：
1. ⏳ I'm working on generating code for this issue. I'll update this issue with a comment and open a pull request when I'm done.
1. ⚠️ I'm having technical difficulties. I couldn't solve the issue. I'm going to try again. This might take some time.
1. ⚠️ I'm having technical difficulties. I couldn't solve the issue. I'm going to try again. This might take some time.
1. 🔴 I'm having technical difficulties. I couldn't solve the issue.
Consider reassigning this issue to a user. This will help you stay within the quotas for generative AI feature usage.
**解决方案**：如果 Amazon Q Developer 无法处理您的问题并为其生成代码，请创建一个新问题并在新问题上贴上 **Amazon Q 开发代理**标签。要了解有关创建议题和应用 Amazon Q 开发者代理标签的更多信息，请参阅[在 GitHub 中使用 Amazon Q 开发者版开发功能并迭代](github-feature-development.md)。