

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# Amazon Q Developer for GitHub (預覽版)
<a name="amazon-q-for-github"></a>

**注意**  
Amazon Q Developer for GitHub 為預覽版本，並可能有所變更。

[Amazon Q Developer for GitHub 或 GitHub Enterprise Cloud](https://github.com/marketplace/amazon-q-developer) 可讓您針對軟體開發工作流程使用 Amazon Q Developer 功能。透過專門的開發代理程式，您可以實作新想法、檢閱品質問題的程式碼，以及透過單元測試解決漏洞。一旦代理程式完成任務，您就可以提供意見回饋，代理程式會對先前的解決方案進行迭代。如需詳細資訊，請參閱[Amazon Q Developer 代理程式](#github-agents)。

您可以透過 [https://github.com/marketplace/amazon-q-developer](https://github.com/marketplace/amazon-q-developer) 存取 Amazon Q Developer 整合，並授權它提供組織儲存庫的存取權。若要開始使用 Amazon Q Developer for GitHub，請參閱 [快速入門：安裝、使用 GitHub 中的功能，以及提高用量限制](github-quickstart.md)。

**重要**  
若要安裝 Amazon Q Developer 應用程式並授權存取 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 Developer 與 GitHub 的整合會在美國境內處理資料。如需詳細資訊，請參閱 [Amazon Q Developer 中的跨區域處理](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/cross-region-processing.html)。

**注意**  
Amazon Q Developer for GitHub (預覽版) 目前不會使用您的內容來改善服務。如果未來啟用此功能，我們會適時通知您，並提供讓您選擇退出此類使用的方式。

**Topics**
+ [安裝 Amazon Q Developer 應用程式並授權存取](#github-concepts-set-up)
+ [Amazon Q Developer 代理程式](#github-agents)
+ [註冊應用程式安裝](#github-concepts-register-app-install)
+ [在 GitHub 中使用瀏覽器延伸模組](#github-concepts-extensions)
+ [在 GitHub 問題和提取請求中使用斜線命令](#github-slash-commands)
+ [快速入門：安裝、使用 GitHub 中的功能，以及提高用量限制](github-quickstart.md)
+ [在 GitHub 中使用 Amazon Q Developer 開發功能和進行迭代](github-feature-development.md)
+ [在 GitHub 中使用 Amazon Q Developer 檢閱程式碼](github-code-reviews.md)
+ [在 Amazon Q Developer 主控台中提高用量限制和設定詳細資訊](github-register-app-install.md)
+ [設定已註冊的安裝詳細資訊](github-configuration.md)
+ [Amazon Q Developer for GitHub 問題故障診斷](github-troubleshooting.md)

## 安裝 Amazon Q Developer 應用程式並授權存取
<a name="github-concepts-set-up"></a>

身為GitHub組織管理員，您可以[https://github.com/apps/amazon-q-developer](https://github.com/apps/amazon-q-developer)免費從 安裝和設定 Amazon Q Developer 應用程式，而無需設定 AWS 帳戶即可開始使用。在安裝過程中，您可以選擇提供 GitHub 組織中所有或所選儲存庫的存取權。安裝並授權後，您就可以取得 GitHub 中 Amazon Q Developer 功能的免費用量。您可以在 [Amazon Q Developer 主控台](https://us-east-1.console.aws.amazon.com/amazonq/developer/home#/github)中註冊應用程式安裝，以增加免費用量。如需詳細資訊，請參閱[快速入門：安裝、使用 GitHub 中的功能，以及提高用量限制](github-quickstart.md)。

**重要**  
若要安裝 Amazon Q Developer 應用程式並授權存取 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)。  
下列 IP 位址可用於存取您的 GitHub 資源：  

```
34.228.181.128
44.219.176.187
54.226.244.221
```

## Amazon Q Developer 代理程式
<a name="github-agents"></a>

從編碼、測試和部署到故障診斷，Amazon Q Developer 代理程式在整個軟體開發生命週期提供支援。
+ **Amazon Q 開發代理程式** - 建立問題並新增功能開發標籤後，Amazon Q Developer 會自動實作您的新功能和錯誤修正。Amazon Q Developer 會建立提取請求，其中包含變更和變更摘要。您也可以在問題註解中使用 `/q dev` 斜線命令初始化功能開發，而不套用標籤。如需詳細資訊，請參閱[在 GitHub 中使用 Amazon Q Developer 開發功能和進行迭代](github-feature-development.md)。
+ **Amazon Q 程式碼檢閱代理程式** - 當新的提取請求建立，或關閉的提取請求重新開啟時，Amazon Q Developer 會自動執行程式碼檢閱，並提供有關程式碼品質、潛在問題和安全疑慮的意見回饋。Amazon Q Developer 也會針對已識別的問題產生修正，您可以進行檢閱並選擇遞交提取請求。程式碼檢閱包含內有執行緒問題清單的程式碼檢閱摘要。您可以在提取請求註解中使用 `/q` 命令與 Amazon Q Developer 互動，以提出有關程式碼檢閱問題清單的問題。

  在現有提取請求內的後續遞交並不會觸發自動程式碼檢閱。您可以使用 `/q review` 斜線命令在提取請求內初始化其他程式碼檢閱。如需詳細資訊，請參閱[在 GitHub 中使用 Amazon Q Developer 檢閱程式碼](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)。

## 註冊應用程式安裝
<a name="github-concepts-register-app-install"></a>

GitHub 的 Amazon Q Developer 整合為免費提供，不需設定 AWS 帳戶即可開始使用。您每月獲得有限的功能開發調用，以及每月程式碼檢閱的有限行數。您可以透過 AWS 帳戶註冊 Amazon Q Developer 應用程式安裝，以增加免費用量。如需詳細資訊，請參閱[在 Amazon Q Developer 主控台中提高用量限制和設定詳細資訊](github-register-app-install.md)。

**重要**  
若要在 Amazon Q Developer 主控台中註冊應用程式安裝，您必須符合 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 中使用瀏覽器延伸模組
<a name="github-concepts-extensions"></a>

您可以在支援的瀏覽器中使用 Amazon Q Developer 擴充功能，在GitHub問題中快速新增功能開發的標籤，而無需搜尋標籤功能表。

Amazon Q Developer 延伸模組適用於下列瀏覽器：
+ [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 問題和提取請求中使用斜線命令
<a name="github-slash-commands"></a>

您可以在 GitHub 問題內的註解中或提取請求中使用斜線命令，以調用 Amazon Q Developer 來執行開發任務或提供支援。
+ `/q dev` - 在 GitHub 問題中調用 Amazon Q Developer，以自動實作新功能和錯誤修正。Amazon Q Developer 會建立提取請求，其中包含變更和變更摘要。
+ `/q review` - 調用 Amazon Q Developer 以在建立或重新開啟提取請求時，自動執行程式碼檢閱。程式碼檢閱提供了有關程式碼品質、潛在問題和安全疑慮的意見回饋，以及建議的修正和包含執行緒問題清單的程式碼檢閱摘要。在提取請求註解中使用 `/q` 與問題清單互動。對現有提取請求的後續遞交並不會觸發自動檢閱。
+ `/q help` - 提供有關 Amazon Q Developer for GitHub 的資訊，包括斜線命令、功能、自訂詳細資訊，以及《Amazon Q Developer 開發人員指南》**中 [Amazon Q Developer for GitHub (預覽版)](#amazon-q-for-github) 文件的連結。

# 快速入門：安裝、使用 GitHub 中的功能，以及提高用量限制
<a name="github-quickstart"></a>

**注意**  
Amazon Q Developer for GitHub 為預覽版本，並可能有所變更。

本教學課程提供下列任務的逐步解說：

1. 從 GitHub Marketplace 安裝 Amazon Q Developer 應用程式，並提供儲存庫的存取權。

1. 在問題中開始使用 Amazon Q Developer，方法是新增標籤進行功能開發，或建立新的提取請求進行程式碼檢閱。或者，您可以在問題中使用斜線命令來啟動功能開發。您也可以使用斜線命令在提取請求內初始化其他程式碼檢閱。

1. （選用） 向 AWS 您的帳戶註冊 Amazon Q Developer 應用程式安裝，以提高您的用量限制。

## 步驟 1：在 GitHub 中安裝 Amazon Q Developer 並授權存取
<a name="github-quickstart-step-1"></a>

您可以GitHub免費使用 Amazon Q Developer，而無需設定 AWS 帳戶即可開始使用。在 GitHub 中使用 Amazon Q Developer 的第一步，是從 [https://github.com/marketplace/amazon-q-developer](https://github.com/marketplace/amazon-q-developer) 安裝應用程式。在此過程中，您可以為 Amazon Q Developer 提供您所有 GitHub 儲存庫或所選取儲存庫的存取權。

**重要**  
若要安裝 Amazon Q Developer 應用程式並授權存取 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 Developer 並授權存取**

1. 瀏覽至 [Amazon Q Developer for GitHub 應用程式](https://github.com/marketplace/amazon-q-developer)頁面。

1. 如有需要，使用您的 GitHub 憑證登入 [https://github.com/](https://github.com/) 帳戶。

1. 檢閱 Amazon Q Developer 應用程式的概觀和功能，然後選擇**安裝**。

1. 執行下列其中一項操作來設定對 GitHub 儲存庫的存取權：

   1. 若要提供所有目前和未來儲存庫的存取權，請選擇**所有儲存庫**。

   1. 若要提供特定儲存庫的存取權，請依序選擇**僅選取的儲存庫**、**選取儲存庫**下拉式清單，然後選擇您要允許存取的儲存庫。

1. 選擇**安裝**以完成在 GitHub 中安裝 Amazon Q Developer 的程序，並授權它存取您的儲存庫。

在 GitHub 中安裝應用程式並授權存取後，系統會將您重新導向至 GitHub 中的 Amazon Q Developer 概觀頁面。您可以瀏覽至 GitHub 儲存庫以開始使用 Amazon Q Developer 功能。

**注意**  
如果您的 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)。  
下列 IP 位址可用於存取您的 GitHub 資源：  

```
34.228.181.128
44.219.176.187
54.226.244.221
```

## 步驟 2：在 GitHub 中使用 Amazon Q Developer 功能
<a name="github-quickstart-step-2"></a>

在 中安裝 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 Developer 開發功能和進行迭代](github-feature-development.md)
+ [在 GitHub 中使用 Amazon Q Developer 檢閱程式碼](github-code-reviews.md)

## 步驟 3：提高免費用量限制並設定詳細資訊
<a name="github-quickstart-step-3"></a>

您可以在 GitHub 中免費使用 Amazon Q Developer 代理程式，不需設定 AWS 帳戶即可開始使用。您每月獲得有限的調用，以進行功能開發和程式碼檢閱。您可以隨時向 AWS 帳戶註冊 Amazon Q Developer 應用程式安裝，以增加您的免費用量。註冊也可讓您設定詳細資訊，例如停用程式碼檢閱，以及新增用於搜尋和篩選的標籤。如需詳細資訊，請參閱[在 Amazon Q Developer 主控台中提高用量限制和設定詳細資訊](github-register-app-install.md)。

**重要**  
若要在 Amazon Q Developer 主控台中註冊應用程式安裝，您必須符合 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 開發功能和進行迭代
<a name="github-feature-development"></a>

**注意**  
Amazon Q Developer for GitHub 為預覽版本，並可能有所變更。

您可以在 GitHub 中使用 Amazon Q Developer 來簡化開發，藉由自動實作新功能和錯誤修正，即可將任務從想法付諸實現，成為完成的提取請求。當您將功能開發標籤新增至問題或使用 `/q dev` 斜線命令時，Amazon Q Developer 會使用問題 (包括其標題和說明)，以及儲存庫程式碼作為內容，來產生新的程式碼修正並建立提取請求。在提取請求上，您可以提供意見回饋，而 Amazon Q Developer 會對建議的程式碼進行迭代。

您可以讓 Amazon Q Developer 每月執行有限次數的功能開發。您可以隨時向 AWS 帳戶註冊 Amazon Q Developer 應用程式安裝，以增加免費用量。如需詳細資訊，請參閱[在 Amazon Q Developer 主控台中提高用量限制和設定詳細資訊](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 Developer 進行功能開發**

1. 如有需要，使用您的 GitHub 憑證登入 [https://github.com/](https://github.com/) 帳戶。

1. 瀏覽至您的 GitHub 組織，然後瀏覽至您要利用 Amazon Q Developer 實作新功能的儲存庫。

1. 選擇**問題**，然後建立新問題或選擇現有問題。如需詳細資訊，請參閱 *GitHub 文件*中的[建立問題](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/creating-an-issue)。

   1. 若是新問題，在**新增標題**文字輸入欄位中，輸入標題以提供內容讓 Amazon Q Developer 進行功能開發 (例如：「建立影像辨識應用程式」)。另外還要包含問題說明，其同樣可提供內容。

     若是現有問題，您可以編輯問題標題和說明，以提供內容讓 Amazon Q Developer 進行功能開發。如需詳細資訊，請參閱 *GitHub 文件*中的[編輯問題](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/editing-an-issue)。

1. 建立問題或設定現有問題時，您可以套用功能開發 Amazon Q Developer 標籤或使用 `/q dev` 斜線命令。執行以下任意一項：
   + 若要將標籤套用至問題，請執行下列其中一項操作：
     + 選擇作為瀏覽器延伸模組提供的**指派至 Amazon Q** 下拉式功能表，然後選擇 **Amazon Q 開發代理程式**標籤。
     + 在右側功能表中，選擇**標籤**，然後選擇 **Amazon Q 開發代理程式**標籤。
   + 若要在註解中使用 `/q dev` 斜線命令：

     1. 在問題內，瀏覽至**新增註解**，然後在註解文字輸入欄位中輸入 `/q dev`。

     1. 選擇 **Comment (評論)**。

1. 若是新問題，選擇**建立問題**來完成建立問題並包含必要的詳細資訊，以供 Amazon Q Developer 開發功能。如果您設定現有問題，請務必儲存變更。如需詳細資訊，請參閱 *GitHub 文件*中的[編輯問題](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/editing-an-issue)。

   當 Amazon Q Developer 完成產生用於功能開發的程式碼變更時，它會在問題上加註，並開啟提取請求。

1. 瀏覽至 Amazon Q Developer 留下的註解 (範例："`I finished the proposed code changes, and the pull request is ready for review: [PR link]`")，然後選擇提取請求連結。

   您也可以瀏覽至**提取請求**索引標籤，然後選擇 Amazon Q Developer 所建立的提取請求。

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 Developer 的方式，對建議的程式碼變更進行迭代。

**若要對 Amazon Q Developer 功能開發程式碼進行迭代**

1. 選擇 Amazon Q Developer 建立的提取請求，然後選擇**檔案已變更**索引標籤以檢視程式碼變更。

1. 或者，對於您想要提供意見回饋的特定程式碼行，選擇 **\$1** 以新增包含意見回饋的評論。

   在對話中，您可以使用 `/q`命令，後面接著自然語言的指示 （例如 `/q implement my suggestions`或 `/q refactor this function for better performance`)。Amazon Q Developer 將以註解回應，說明會根據您的意見回饋所做的變更 （例如，「我會根據意見回饋實作下列變更：...」)。實作完成時，Amazon Q Developer 將發佈另一個評論，確認變更 （例如「我已實作建議的變更」) 以及產生遞交的連結，您可以在其中檢視變更。

1. 遵循對話中提供的遞交連結，檢閱 Amazon Q Developer 所做的變更。您可以使用 `/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 Developer 檢閱程式碼
<a name="github-code-reviews"></a>

**注意**  
Amazon Q Developer for GitHub 為預覽版本，並可能有所變更。

Amazon Q Developer 會在 GitHub 內啟用自動程式碼檢閱。當您建立新的提取請求或重新開啟關閉的提取請求時，Amazon Q Developer 會自動執行程式碼檢閱，並提供有關程式碼品質、潛在問題和高嚴重性問題清單的意見回饋。每一項檢閱都包含內有執行緒問題清單的程式碼檢閱摘要。Amazon Q Developer 也會針對已識別的問題產生修正，您可以進行檢閱並選擇遞交提取請求。您可以在提取請求註解中使用 `/q` 命令來提出有關程式碼檢閱問題清單的問題並進行互動。在現有提取請求內的後續遞交並不會觸發自動程式碼檢閱。

**注意**  
該程式碼會檢閱 Amazon Q Developer 主控台中的功能設定，控制在建立或重新開啟提取請求時執行的自動程式碼檢閱。此設定不會影響在提取請求註解中使用`/q review`斜線命令啟動程式碼檢閱。

您也可以使用 `/q review` 斜線命令在提取請求內初始化程式碼檢閱。您可以在新的提取請求註解中新增斜線命令，該命令會以其目前狀態初始化提取請求的新程式碼檢閱，包括任何註解和新的遞交。如需詳細資訊，請參閱[在 GitHub 提取請求內初始化程式碼檢閱](#github-code-reviews-in-pr)。

您可以讓 Amazon Q Developer 每月執行有限行數的程式碼檢閱。您可以隨時向 AWS 帳戶註冊 Amazon Q Developer 應用程式安裝，以增加免費用量。如需詳細資訊，請參閱[在 Amazon Q Developer 主控台中提高用量限制和設定詳細資訊](github-register-app-install.md)。

**注意**  
如果先前已停用程式碼檢閱功能，則您必須先在 [Amazon Q Developer 主控台](https://us-east-1.console.aws.amazon.com/amazonq/developer/home#/github)中啟用該功能，才能在 GitHub 中套用標籤。如需詳細資訊，請參閱[在 GitHub 中編輯適用於 Amazon Q Developer 的功能](github-configuration.md#github-edit-features)。

## 先決條件
<a name="github-code-reviews-prerequisites"></a>

您需具有目標 GitHub 儲存庫的適當許可，才能使用 Amazon Q Developer 初始化程式碼檢閱。支援的儲存庫角色包括寫入、維護或管理員。具有讀取或分類角色的使用者，以及沒有角色的成員，都無法使用 Amazon Q Developer 初始化程式碼檢閱。

具有分類角色的 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 提取請求的程式碼檢閱
<a name="github-new-code-reviews-pr"></a>

當您開啟新的提取請求或重新開啟先前關閉的提取請求時，Amazon Q Developer 會自動執行程式碼檢閱，並提供有關程式碼品質、潛在問題和重大問題清單的意見回饋。

**若要使用 Amazon Q Developer 進行程式碼檢閱並套用修正**

在開始檢閱之前，您可以先在 `project-root/.amazonq/rules` 目錄內的簡易 Markdown 檔案中定義自訂編碼標準，以自訂程式碼品質檢閱。Amazon Q 會自動依照您的準則，確保整個專案的程式碼品質一致。如需詳細資訊，請參閱[在第三方平台中為 Amazon Q Developer 建立專案規則](third-party-context-project-rules.md)。

1. 如有需要，使用您的 GitHub 憑證登入 [https://github.com/](https://github.com/) 帳戶。

1. 瀏覽至您的 GitHub 組織，然後瀏覽至您要利用 Amazon Q Developer 執行程式碼檢閱的儲存庫。

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 Developer 會自動開始進行程式碼檢閱，以找出潛在問題。Amazon Q Developer 完成檢閱後，會提供程式碼檢閱摘要。每個問題清單都會在摘要下顯示為執行緒註解，且包含可供您遞交至提取請求的建議修正。

1. 要求代理程式實作變更，並直接在提取請求的來源分支上建立遞交。您可以張貼註解，以自然語言開頭`/q`，後面接著您的請求，讓客服人員進行變更。

1. (選用) 提出有關特定問題清單的問題。在提取請求內，瀏覽至**新增註解**，然後在註解文字輸入欄位中輸入 `/q`，後面接著輸入您的問題 (例如 "`/q explain the importance of this finding`")。

1. 檢閱 Amazon Q Developer 提議的程式碼變更，選擇**遞交建議**，然後選擇**遞交變更**以更新提取請求。

1. 如果您對建議的程式碼修正感到滿意，就可以合併提取請求，以套用 Amazon Q Developer 建議的變更。如需詳細資訊，請參閱文件 *GitHub 文件*中的[合併提取請求](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)。

## 在 GitHub 提取請求內初始化程式碼檢閱
<a name="github-code-reviews-in-pr"></a>

Amazon Q Developer 針對新的或重新開啟的 GitHub 提取請求執行自動程式碼檢閱之後，您就可以使用 `/q review` 斜線命令初始化其他程式碼檢閱，以對程式碼進行迭代。程式碼檢閱是對整個提取請求的差異執行。

**注意**  
您只能在有新註解的提取請求內初始化程式碼檢閱。`/q review` 斜線命令無法在現有的註解執行緒中運作。Amazon Q Developer `/q review` 主控台中的程式碼檢閱功能設定不會影響使用斜線命令啟動程式碼檢閱。

**若要在提取請求中初始化程式碼檢閱**

1. 如有需要，使用您的 GitHub 憑證登入 [https://github.com/](https://github.com/) 帳戶。

1. 瀏覽至您的 GitHub 組織，然後瀏覽至您要利用 Amazon Q Developer 執行程式碼檢閱的提取請求。如需詳細資訊，請參閱[關於提取請求](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 Developer 可能需要幾分鐘的時間才能完成分析提取請求程式碼。Amazon Q Developer 完成分析後，會提供程式碼檢閱摘要。每個問題清單都會在摘要下顯示為執行緒註解，且包含可供選擇遞交和更新提取請求的提議變更。

1. (選用) 提出有關特定問題清單的問題。在提取請求內，瀏覽至**新增註解**，然後在註解文字輸入欄位中輸入 `/q`，後面接著輸入您的問題 (例如 "`/q explain the importance of this finding`")。

1. 如果您對建議的程式碼修正感到滿意，就可以合併提取請求，以套用 Amazon Q Developer 建議的變更。如需詳細資訊，請參閱文件 *GitHub 文件*中的[合併提取請求](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)。

# 在 Amazon Q Developer 主控台中提高用量限制和設定詳細資訊
<a name="github-register-app-install"></a>

**注意**  
Amazon Q Developer for GitHub 為預覽版本，並可能有所變更。

您可以在 中GitHub免費使用 Amazon Q Developer 代理程式，而無需設定 AWS 帳戶即可開始使用。對於功能開發和程式碼檢閱功能，您每月會收到有限的調用。您可以隨時向 AWS 帳戶註冊 Amazon Q Developer 應用程式安裝，以增加您的免費用量。

根據預設，當您安裝應用程式GitHub時，**程式碼檢閱**和**功能開發**功能會在 中啟用。您可以在註冊時停用這些功能。註冊需要 Amazon Q Developer 設定檔，才能從主控台管理功能。設定檔會儲存您的設定和程式碼建議自訂。

**重要**  
若要在 Amazon Q Developer 主控台中註冊應用程式安裝，您必須符合 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 Developer 安裝**

1. 瀏覽至 [Amazon Q Developer 主控台](https://us-east-1.console.aws.amazon.com/amazonq/developer/home)。

1. 選擇頁面頂端的**啟用 Q 開發人員**，然後依照提示啟用 Kiro 和 Amazon Q 開發人員。

   如果您先前已啟用 Kiro 和 Amazon Q Developer，請跳至步驟 3。

1. 在導覽窗格中，選擇 **中的 Amazon Q DeveloperGitHub**。

1. 選擇**註冊安裝**，然後選擇**授權**以前往 GitHub。

   如果您先前已授權 Amazon Q Developer 存取您的 GitHub 組織，則系統會將您重新導向回 Amazon Q Developer 主控台。在此情況下，請跳至步驟 7。

1. 使用您的 GitHub 憑證登入 GitHub 帳戶。如果您有多個帳戶，請選擇要為 Amazon Q Developer 提供存取權的帳戶。

1. 選擇**授權 Amazon Q Developer** 以提供 GitHub 帳戶的存取權。授權後，系統會將您重新導向回 Amazon Q Developer 主控台。

1. 在**註冊詳細資訊**下，輸入您的 GitHub 詳細資訊，選擇性地設定程式碼檢閱功能，並新增標籤。

   1. 在**註冊名稱**文字輸入欄位中，輸入應用程式安裝的名稱。

   1. (選用) 在**組織名稱 - *選用***文字輸入欄位中，輸入與應用程式安裝相關聯的組織名稱。

   1. (選用) 在**功能**下，選擇切換開關以啟用或停用功能，藉此設定**程式碼檢閱**功能。功能**開發**組態無法修改，且預設為啟用。

   1. （選用） 在**標籤 - 選用**下，選擇**新增標籤**以新增標籤，以協助搜尋和篩選 中的 AWS 資源GitHub。

1. 選擇**註冊**以向 AWS 您的帳戶GitHub在 中註冊應用程式安裝。

成功註冊應用程式安裝後，您可以檢視註冊詳細資訊。您仍然可以啟用或停用程式碼檢閱功能，以及稍後新增標籤。您也可以刪除註冊。如需詳細資訊，請參閱[設定已註冊的安裝詳細資訊](github-configuration.md)。

# 設定已註冊的安裝詳細資訊
<a name="github-configuration"></a>

**注意**  
Amazon Q Developer for GitHub 為預覽版本，並可能有所變更。

建立 Amazon Q Developer 設定檔並在 GitHub 中註冊應用程式安裝後，您可以從 Amazon Q Developer 主控台執行下列操作：
+ 啟用或停用程式碼檢閱的使用。功能開發組態目前無法修改。
+ 尋找瀏覽器延伸模組的連結，其提供了在 GitHub 問題中新增 Amazon Q Developer 功能標籤的方式。
+ 新增標籤以搜尋和篩選您的資源或追蹤 AWS 成本。
+ 刪除 GitHub 應用程式安裝註冊。

## 在 GitHub 中編輯適用於 Amazon Q Developer 的功能
<a name="github-edit-features"></a>

GitHub 中可供 Amazon Q Developer 使用的功能，會在您於 GitHub 中安裝應用程式並提供授權以存取組織時，預設為啟用。如果您不想再使用 GitHub 中的功能，可以選擇停用該功能。

**若要在 GitHub 中啟用或停用適用於 Amazon Q Developer 的功能**

1. 瀏覽至 [Amazon Q Developer 主控台](https://us-east-1.console.aws.amazon.com/amazonq/developer/home#/github)。

1. 在導覽窗格中，於 **GitHub 中的 Amazon Q Developer** 下，選擇**已註冊的安裝**。

1. 在**名稱**欄下，選擇您要啟用或停用功能之安裝的註冊名稱。

1. 在**功能**下，選擇**編輯**以設定功能可用性。

1. 在強制回應中，選擇您要啟用或停用之功能的切換開關，然後選擇**儲存**以確認變更。

在 [Amazon Q Developer 主控台](https://us-east-1.console.aws.amazon.com/amazonq/developer/home#/github)中啟用或停用功能之後，變更會反映在 GitHub 中。在停用功能之後，嘗試將問題指派至 Amazon Q Developer 標籤將會導致錯誤。如果功能已停用，則新的提取請求中將不再進行程式碼檢閱。

## 安裝瀏覽器延伸模組
<a name="github-extensions"></a>

您可以在其中一個支援的瀏覽器中安裝 Amazon Q Developer 延伸模組。擴充功能可讓您在GitHub發生問題時快速將功能開發任務指派給 Amazon Q Developer，而無需搜尋標籤功能表。

Amazon Q Developer 延伸模組適用於下列瀏覽器：
+ [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 Developer 主控台](https://us-east-1.console.aws.amazon.com/amazonq/developer/home#/github)的註冊安裝詳細資訊頁面上，檢視支援的瀏覽器。

## 刪除 Amazon Q Developer GitHub 應用程式安裝註冊
<a name="github-delete-app-install"></a>

您可以透過 Amazon Q Developer 主控台刪除一或多個 GitHub 應用程式安裝的註冊。永久刪除註冊後，與該註冊相關聯的所有資料也會一併刪除。這個動作無法復原。

**若要刪除 GitHub 應用程式安裝**

1. 瀏覽至 [Amazon Q Developer 主控台](https://us-east-1.console.aws.amazon.com/amazonq/developer/home#/github)。

1. 在導覽窗格中，於 **GitHub 中的 Amazon Q Developer** 下，選擇**已註冊的安裝**。

1. 執行以下任意一項：
   + 在**動作**欄下，針對您要刪除的安裝選擇**刪除註冊**。
   + 在**名稱**欄下，選擇您要刪除之安裝的註冊名稱，然後選擇**刪除**。

   在**動作**欄下，針對您要刪除的已註冊安裝選擇**刪除註冊**。

1. 在強制回應中，檢閱刪除註冊的詳細資訊。

1. 在文字輸入欄位中，輸入 **confirm**，然後選擇**刪除**以確認變更。

在您刪除 GitHub 應用程式安裝後，您可以選擇註冊新的安裝。

# Amazon Q Developer for GitHub 問題故障診斷
<a name="github-troubleshooting"></a>

請參閱下一節，了解如何針對使用 Amazon Q Developer for GitHub 時的常見問題進行故障診斷。

## Amazon Q Developer 未在具有分支保護規則的儲存庫中產生提取請求
<a name="github-troubleshooting-branch-protection"></a>

**問題**：Amazon Q Developer 無法在擁有分支保護規則的 GitHub 儲存庫中建立提取請求。

**解決方案**：分支保護規則會阻止 Amazon Q Developer 建立分支以建立提取請求。若要在具有分支保護規則的儲存庫中使用 Amazon Q Developer for GitHub，您需要將 Amazon Q Developer 應用程式新增至允許清單。

**若要將 Amazon Q Developer 應用程式新增至允許清單**

1. 如有需要，使用您的 GitHub 憑證登入 [https://github.com/](https://github.com/) 帳戶。

1. 瀏覽至您的 GitHub 組織，然後瀏覽至您要將 Amazon Q Developer for GitHub 應用程式加入允許清單的儲存庫。

1. 選擇**設定**，然後從導覽窗格中選擇**分支**。

1. 在**分支保護規則**下，選擇**編輯**以修改分支保護規則。

1. 選擇**限制建立相符分支的推送**，並搜尋 Amazon Q Developer for GitHub 應用程式。

1. 選擇**儲存變更**，以允許 Amazon Q Developer 針對有 Amazon Q Developer 標籤的問題建立提取請求。

若要進一步了解如何修改 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 Developer 標籤
<a name="github-troubleshooting-labels"></a>

**問題**：我在GitHub問題中看不到 **Amazon Q 開發代理程式**標籤。

**解決方案**：如果在為GitHub應用程式安裝 Amazon Q Developer 時未自動建立標籤，或意外刪除標籤，您可以在 中手動建立標籤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 Developer 未針對 GitHub 問題建立程式碼
<a name="github-troubleshooting-generate-code"></a>

**問題**：我已建立 GitHub 問題並調用 Amazon Q Developer 來執行任務，但收到下面一系列有關技術問題的訊息：

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 Developer 代理程式標籤，請參閱 [在 GitHub 中使用 Amazon Q Developer 開發功能和進行迭代](github-feature-development.md)。