GitHub Copilot コード レビューの使用

Copilot コード レビュー の使用

以下の手順では、GitHub Web サイトで Copilot コード レビュー を使う方法について説明します。 その他の一般的なコーディング環境の説明を確認するには、ページの上部にあるツール スイッチャーを使います。

1. GitHub.com で、pull request を作成するか、既存の pull request に移動します。

2. [Reviewers] メニューを開き、[Copilot] を選びます。

   

3. Copilot が pull request をレビューするまで待ちます。 通常、これにかかる時間は 30 秒未満です。

4. 下にスクロールして、Copilot のコメントを読みます。

   

   Copilot は常に、"承認" レビューや "変更要求" レビューではなく、"コメント" レビューを残します。 つまり、Copilot のレビューは pull request の必須の承認にはカウントされず、Copilot のレビューによって変更のマージが禁止されることはありません。 詳細については、「必須レビューでのプルリクエストの承認」を参照してください。

5. Copilot のレビュー コメントは、人間によるレビュー コメントと同様に動作します。 それにリアクションを追加したり、コメントしたり、それを解決したり、非表示にしたりできます。

   Copilot のレビュー コメントに追加したコメントはユーザーに対しては表示されますが、Copilot には表示されず、Copilot は返信しません。

Copilot によって提供される提案された変更の処理

可能であれば、Copilot のフィードバックには、2 回のクリックで適用できる推奨される変更が含まれています。

変更に満足できる場合は、Copilot からの 1 つの提案を受け入れてコミットするか、提案のグループを 1 回のコミットでまとめて受け入れます。 詳しくは、「プルリクエストでのフィードバックを取り込む」をご覧ください。

Copilot のレビューに対するフィードバックの提供

Copilot のコメントに対するフィードバックは、各コメント内で直接提供できます。 この情報は、製品と Copilot の提案の品質の向上に使われます。

1. Copilot による pull request レビューのコメントで、サムアップ (👍) またはサムダウン (👎) ボタンをクリックします。

   

2. サムダウン ボタンをクリックした場合は、追加情報の提供を求められます。 必要に応じて、否定的なフィードバックの理由を選び、コメントを残してから、[Submit feedback] をクリックできます。

   

Copilot による再レビューの要求

Copilot がレビューした pull request への変更をプッシュしても、変更の再レビューは自動的には行われません。

Copilot による再レビューを要求するには、[Reviewers] メニューの Copilot の名前の横にある ボタンをクリックします。 詳しくは、「Pull Request レビューをリクエストする」をご覧ください。

自動レビューを有効にする

既定では、人間にレビューを依頼するのと同じ方法で、pull request ごとに Copilot から手動でレビューを依頼します。 ただし、すべての pull request を自動的にレビューするように Copilot を設定することはできます。 「Copilot を使って自動コード レビューを構成する」を参照してください。

カスタム指示を使用した Copilot のレビューのカスタマイズ

コードのレビュー時に Copilot で考慮すべき情報を含む .github/copilot-instructions.md ファイルをリポジトリに追加することで、Copilot コード レビュー をカスタマイズできます。 これは、Copilot Chat で使われるのと同じ copilot-instructions.md です。 「GitHub Copilot のリポジトリ カスタム命令を追加する」を参照してください。

例

この例の .github/copilot-instructions.md ファイルには、リポジトリ内のすべての Copilot コード レビュー に適用される 3 つの指示が含まれています。

When performing a code review, respond in Spanish.

When performing a code review, follow our internal security checklist.

When performing a code review, focus on readability and avoid nested ternary operators.

コーディング ガイドラインを使用した Copilot のレビューのカスタマイズ

Visual Studio Code または GitHub Web サイトで Copilot コード レビュー を使って変更をレビューする場合は、自然言語で記述されたカスタム コーディング ガイドラインを使って Copilot のレビューをカスタマイズできます。 Copilot は、コードをレビューするときにそのコーディング ガイドラインに基づいてフィードバックを提供します。 詳しくは、「GitHub Copilot コード レビューのコーディング ガイドラインの構成」をご覧ください。

コーディング ガイドラインに基づいて生成されたコメントには、そのソースを明確に示すメッセージが含まれます。