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

2 種類の Copilot コード レビュー を使用できます。

• 選択内容のレビュー: コードを範囲選択し、最初のレビューを依頼します (VS Code でのみ使用可能)
• 変更のレビュー: すべての変更について詳細なレビューを依頼します (VS Code と GitHub Web サイトで使用可能)

このバージョンの記事は、GitHub Web サイトの Copilot コード レビュー に関連しています。 Copilot コード レビュー における選択内容のレビューの種類に関する情報を表示するには、ページの上部にある [Visual Studio Code] ツール スイッチャーをクリックします。

可用性

GitHub Web サイトの Copilot コード レビュー は Premium 機能であり、Copilot Pro、Copilot Pro+、Copilot Business、Copilot Enterprise プランで使用できます。

コード レビューの月間クォータ

Copilot コード レビュー の種類である変更レビューは、1 人あたりの月間クォータを使用する Premium 機能です。

pull request をレビューするために Copilot を割り当てると、Copilot が pull request にコメントを投稿するたびに、1 つの Premium リクエストが月間クォータから差し引かれます。 「Understanding and managing requests in Copilot」を参照してください。

リポジトリがすべての新しい pull request についてコード レビューを Copilot に自動的に要求するように構成されている場合、Premium リクエストの使用量は pull request 作成者のクォータに適用されます。 pull request が GitHub Actions またはボットによって作成された場合、ワークフローをトリガーしたユーザー (特定できる場合)、または指定された課金所有者に使用量が適用されます。

月間クォータに達すると、Copilot プランをアップグレードするか追加の Premium リクエストを有効にしない限り、クォータがリセットされるまで Copilot のコード レビューを受け取ることができません。

サポートされている言語

GitHub Web サイト上の Copilot コード レビュー では、すべての言語がサポートされています。

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

Copilot による pull request レビューの要求

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 のリポジトリ カスタム命令を追加する」を参照してください。

コード レビューに対するカスタム指示を有効または無効にするには、リポジトリの設定に移動してから、[Copilot] の下にある [Code Review] に移動して、[Use custom instructions when reviewing pull requests] オプションを切り替えます。

例

この例の .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 コード レビューのコーディング ガイドラインの構成」をご覧ください。

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