在 GitHub 中使用 Amazon Q Developer 檢閱程式碼 - Amazon Q Developer
先決條件初始化 GitHub 提取請求的程式碼檢閱在 GitHub 提取請求內初始化程式碼檢閱

在 GitHub 中使用 Amazon Q Developer 檢閱程式碼

注意

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

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

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

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

注意

如果先前已停用程式碼檢閱功能，則您必須先在 Amazon Q Developer 主控台中啟用該功能，才能在 GitHub 中套用標籤。如需詳細資訊，請參閱 在 GitHub 中編輯適用於 Amazon Q Developer 的功能。

先決條件

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

具有分類角色的 GitHub 使用者仍可檢閱儲存庫中的提取請求。無論角色為何，任何使用者都可以檢閱公有儲存庫中的提取請求。

如需詳細資訊，請參閱 GitHub 文件中的組織的儲存庫角色和關於預先定義的組織角色。

初始化 GitHub 提取請求的程式碼檢閱

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

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

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

  1. 如有需要，使用您的 GitHub 憑證登入 GitHub 帳戶。

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

  3. 對於原始程式碼所做的變更，建立新的提取請求。如需詳細資訊，請參閱文件 GitHub 文件中的建立提取請求。

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

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

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

  6. 如果您對建議的程式碼修正感到滿意，就可以合併提取請求，以套用 Amazon Q Developer 建議的變更。如需詳細資訊，請參閱文件 GitHub 文件中的合併提取請求。

在 GitHub 提取請求內初始化程式碼檢閱

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

注意

您只能在有新註解的提取請求內初始化程式碼檢閱。/q review 斜線命令無法在現有的註解執行緒中運作。

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

  1. 如有需要，使用您的 GitHub 憑證登入 GitHub 帳戶。

  2. 瀏覽至您的 GitHub 組織，然後瀏覽至您要利用 Amazon Q Developer 執行程式碼檢閱的提取請求。如需詳細資訊，請參閱關於提取請求。

  3. 在提取請求內，瀏覽至新增註解，然後在註解文字輸入欄位中輸入 /q review。

  4. 選擇註解以初始化程式碼檢閱。

    Amazon Q Developer 可能需要幾分鐘的時間才能完成分析提取請求程式碼。Amazon Q Developer 完成分析後，會提供程式碼檢閱摘要。每個問題清單都會在摘要下顯示為執行緒註解，且包含可供選擇遞交和更新提取請求的提議變更。

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

  6. 如果您對建議的程式碼修正感到滿意，就可以合併提取請求，以套用 Amazon Q Developer 建議的變更。如需詳細資訊，請參閱文件 GitHub 文件中的合併提取請求。