Amazon Q Developer in GitHub を使用したコードレビュー - Amazon Q Developer
前提条件GitHub プルリクエストのコードレビューの開始GitHub プルリクエスト内でのコードレビューの開始

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

Amazon Q Developer in GitHub を使用したコードレビュー

注記

Amazon Q Developer for GitHub はプレビューリリースであり、変更される可能性があります。

Amazon Q Developer は、GitHub 内で自動コードレビューを有効化します。新しいプルリクエストを作成するか、クローズドプルリクエストを再開すると、Amazon Q Developer は自動的にコードレビューを実行し、コードの品質、潜在的な問題、重要度の高い検出結果に関するフィードバックを提供します。各レビューには、スレッド化された検出結果を含むコードレビューの概要が含まれます。Amazon Q Developer は、特定された問題の修正も生成します。これを確認してプルリクエストにコミットすることができます。プルリクエストコメントで /q コマンドを使用して、コードレビューの結果について質問したりやり取りしたりすることができます。自動コードレビューは、既存のプルリクエスト内で行われた後続のコミットによってトリガーされません。

/q review スラッシュコマンドを使用して、プルリクエスト内でコードレビューを開始することもできます。スラッシュコマンドを新しいプルリクエストコメントに追加できます。これにより、コメントや新しいコミットを含め、現在のステータスでプルリクエストの新しいコードレビューが開始されます。詳細については、「GitHub プルリクエスト内でのコードレビューの開始」を参照してください。

Amazon Q Developer は、1 か月あたり限られた数の行に対してコードレビューを実行できます。Amazon Q Developer アプリのインストールを AWS アカウントに登録することで、いつでも無料利用を増やすことができます。詳細については、「Amazon Q Developer コンソールの使用制限の引き上げと詳細の設定」を参照してください。

注記

コードレビュー機能が以前に無効になっている場合は、GitHub でラベルを適用する前に Amazon Q Developer コンソールで有効にする必要があります。詳細については、「Amazon Q Developer in GitHub の機能の編集」を参照してください。

前提条件

Amazon Q Developer でコードレビューを開始する前に、ターゲット GitHub リポジトリに対する適切なアクセス許可が必要です。サポートされているリポジトリロールは、書き込み、メンテナンス、または管理者です。読み取りロールまたはトリアージロールを持つユーザー、およびロールを持たないメンバーは、Amazon Q Developer でコードレビューを開始できません。

GitHub トリアージロールを持つユーザーは、リポジトリ内のプルリクエストを引き続きレビューできます。ロールに関係なく、ユーザーはパブリックリポジトリでプルリクエストをレビューできます。

詳細については、「GitHub ドキュメント」の「Organization のリポジトリロール」および「事前に定義済みの組織の役割について」を参照してください。

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 ドキュメント」の「pull request の作成」を参照してください。

    新しいプルリクエストを作成すると、Amazon Q Developer は自動的にコードレビューを開始し、潜在的な問題を検出します。Amazon Q Developer がレビューを完了すると、コードレビューの概要が表示されます。各検出結果は、プルリクエストにコミットできる推奨される修正とともに、概要の下にスレッドコメントとして表示されます。

  4. 変更を実装し、プルリクエストのソースブランチに直接コミットを作成するようにエージェントに依頼します。これを行うには、 で始まり/q、その後にエージェントが変更を加えるためのリクエストを自然言語で投稿します。

  5. (オプション) 特定の検出結果について質問します。プルリクエスト内で、[コメントの追加] に移動し、コメントテキスト入力フィールドに、質問 (「/q explain the importance of this finding」など) に続けて「/q」と入力します。

  6. Amazon Q Developer によって提案されたコード変更を確認し、[提案をコミットする] を選択し、[変更をコミットする] を選択してプルリクエストを更新します。

  7. 提案されたコード修正に問題がない場合は、プルリクエストをマージして、Amazon Q Developer によって提案されたコード変更を適用できます。詳細については、「GitHub ドキュメント」の「pull request のマージ」を参照してください。

GitHub プルリクエスト内でのコードレビューの開始

Amazon Q Developer が新規または再開された GitHub プルリクエストに対して自動コードレビューを実行した後、/q review スラッシュコマンドを使用して追加のコードレビューを開始してコードのイテレーションを実行できます。コードレビューは、プルリクエストの差分全体に対して実行されます。

注記

コードレビューは、新しいコメントを含むプルリクエスト内でのみ開始できます。/q review スラッシュコマンドは、既存のコメントスレッドでは機能しません。

プルリクエストでコードレビューの開始するには

  1. 必要に応じて、GitHub 認証情報を使用して GitHub アカウントにサインインします。

  2. GitHub 組織に移動し、Amazon Q Developer でコードレビューを実行するプルリクエストに移動します。詳細については、「pull requests について」を参照してください。

  3. プルリクエスト内で [コメントの追加] に移動し、コメントテキスト入力フィールドに「/q review」と入力します。

  4. [コメント] を選択してコードレビューを開始します。

    Amazon Q Developer がプルリクエストコードの分析を完了するまでに数分かかる場合があります。Amazon Q Developer が分析を完了すると、コードレビューの概要が表示されます。各検出結果は、プルリクエストにコミットおよびアップデートできる提案される変更とともに、概要の下にスレッドコメントとして表示されます。

  5. (オプション) 特定の検出結果について質問します。プルリクエスト内で、[コメントの追加] に移動し、コメントテキスト入力フィールドに、質問 (「/q explain the importance of this finding」など) に続けて「/q」と入力します。

  6. 提案されたコード修正に問題がない場合は、プルリクエストをマージして、Amazon Q Developer によって提案されたコード変更を適用できます。詳細については、「GitHub ドキュメント」の「pull request のマージ」を参照してください。