はじめに
GitHub Copilot は、コードをレビューしてフィードバックを提供できます。 可能であれば、Copilot のフィードバックには、2 回のクリックで適用できる推奨される変更が含まれています。
GitHub Copilot コード レビュー の詳細内容については、「GitHub Copilot のコード レビューについて」を参照してください。
Copilot コード レビュー の使用
以下の手順では、GitHub Web サイトで Copilot コード レビュー を使う方法について説明します。 他の一般的なコーディング環境での指示を見るには、ページの上部で適切なタブをクリックしてください。
-
GitHub.com で、pull request を作成するか、既存の pull request に移動します。
-
[Reviewers] メニューを開き、[Copilot] を選びます。
-
Copilot が pull request をレビューするまで待ちます。 通常、これにかかる時間は 30 秒未満です。
-
下にスクロールして、Copilot のコメントを読みます。
Copilot は常に、"承認" レビューや "変更要求" レビューではなく、"コメント" レビューを残します。 つまり、Copilot のレビューは pull request の必須の承認にはカウントされず、Copilot のレビューによって変更のマージが禁止されることはありません。 詳細については、「必須レビューでのプルリクエストの承認」を参照してください。
-
Copilot のレビュー コメントは、人間によるレビュー コメントと同様に動作します。 それにリアクションを追加したり、コメントしたり、それを解決したり、非表示にしたりできます。
Copilot のレビュー コメントに追加したコメントはユーザーに対しては表示されますが、Copilot には表示されず、Copilot は返信しません。
Copilot によって提供される提案された変更の処理
可能であれば、Copilot のフィードバックには、2 回のクリックで適用できる推奨される変更が含まれています。
変更に満足できる場合は、Copilot からの 1 つの提案を受け入れてコミットするか、提案のグループを 1 回のコミットでまとめて受け入れます。 詳しくは、「プルリクエストでのフィードバックを取り込む」をご覧ください。
Copilot のレビューに対するフィードバックの提供
Copilot のコメントに対するフィードバックは、各コメント内で直接提供できます。 この情報は、製品と Copilot の提案の品質の向上に使われます。
-
Copilot による pull request レビューのコメントで、サムアップ (👍) またはサムダウン (👎) ボタンをクリックします。
-
サムダウン ボタンをクリックした場合は、追加情報の提供を求められます。 必要に応じて、否定的なフィードバックの理由を選び、コメントを残してから、[Submit feedback] をクリックできます。
Copilot による再レビューの要求
Copilot がレビューした pull request への変更をプッシュしても、変更の再レビューは自動的には行われません。
Copilot による再レビューを要求するには、[Reviewers] メニューの Copilot の名前の横にある ボタンをクリックします。 詳しくは、「Pull Request レビューをリクエストする」をご覧ください。
メモ
pull request を再レビューしたとき、[Resolve conversation] ボタンで無視したり、サムダウン (👎) ボタンで反対票を入れたりしたのと同じコメントが、Copilot によってもう一度繰り返される可能性があります。
自動レビューを有効にする
既定では、人間にレビューを依頼するのと同じ方法で、pull request ごとに Copilot から手動でレビューを依頼します。 ただし、すべての pull request を自動的にレビューするように Copilot を設定することはできます。 「GitHub Copilot による自動コード レビューの構成」を参照してください。
カスタム指示を使用した Copilot のレビューのカスタマイズ
メモ
Copilot コード レビュー に対するカスタム指示は パブリック プレビュー 段階であり、変更される可能性があります。
Copilot Business または Copilot Enterprise プランをお使いの場合、パブリック プレビュー の期間中は、プランを提供する organization または Enterprise で [Opt in to preview features] の設定が有効にされている必要があります。 「GitHub Copilot のポリシーと機能を Organization で管理する」または「Enterprise での GitHub 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.
コードの選択のレビュー
Visual Studio Code で強調表示されているコードの選択の初期レビューを要求できます。
-
Visual Studio Code で、レビューするコードを選択します。
-
VS Code Command Palette を開きます。
- Mac の場合:
- Shift+Command+P キーを使用します。
- Windows または Linux の場合:
- Ctrl+Shift+P キーを使用します。
- Mac の場合:
-
コマンド パレットで、[GitHub Copilot: Review and Comment] を検索して選びます。
-
Copilot によって変更のレビューが行われるまで待ちます。 通常、これにかかる時間は 30 秒未満です。
-
Copilot にコメントがある場合は、ファイル内のインラインと [Problems] タブで示されます。
コミットされていないすべての変更をレビューする
Visual Studio Code で確定されていない変更のレビューを要求できます。
-
VS Code のアクティビティ バーで [Source Control] ボタンをクリックします。
-
[Source Control] ビューの上部にある [CHANGES] にマウス ポインターを移動した後、 の [Copilot Code Review - Uncommitted Changes] ボタンをクリックします。
-
Copilot によって変更のレビューが行われるまで待ちます。 通常、これにかかる時間は 30 秒未満です。
-
Copilot にコメントがある場合は、ファイル内のインラインと [Problems] タブで示されます。
Copilot によって提供される提案された変更の処理
可能であれば、Copilot のフィードバックには、1 回のクリックで適用できる推奨される変更が含まれています。
変更に問題がない場合は、[Apply and Go To Next] ボタンをクリックして、Copilot からの提案を受け入れることができます。 適用した変更は自動的にはコミットされません。
Copilot が提案する変更を適用しない場合は、[Discard and Go to Next] ボタンをクリックします。
Copilot のレビューに対するフィードバックの提供
Copilot のコメントに対するフィードバックは、各コメント内で直接提供できます。 この情報は、製品と Copilot の提案の品質の向上に使われます。
フィードバックを提供するには、コメントをポイントして、サムアップまたはサムダウン ボタンをクリックします。
カスタム指示を使用した Copilot のレビューのカスタマイズ
メモ
Copilot コード レビュー に対するカスタム指示は パブリック プレビュー 段階であり、変更される可能性があります。
Copilot Business または Copilot Enterprise プランをお使いの場合、パブリック プレビュー の期間中は、プランを提供する organization または Enterprise で [Opt in to preview features] の設定が有効にされている必要があります。 「GitHub Copilot のポリシーと機能を Organization で管理する」または「Enterprise での GitHub 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 バージョン 17.14 以降を使う必要があります。 Visual Studio のダウンロード ページを参照してください。
Copilot コード レビュー の使用
以下の手順では、Visual Studio で Copilot コード レビュー を使う方法について説明します。 他の一般的なコーディング環境での指示を見るには、ページの上部で適切なタブをクリックしてください。
-
[Git Changes] ウィンドウで、[Review changes with Copilot] をクリックします。 このボタンは、輝きで表されるコメント アイコンとして表示されます。
-
Copilot によるユーザーの変更のレビューが始まります。 しばらくすると、コード レビューのコメントの数を示すリンクが [Git Changes] ウィンドウに表示されます。
-
リンクをクリックしてコメントを表示し、内容を確認します。 問題が見つからなかった場合は、"Copilot did not comment on any files" というメッセージが表示されます。
-
Copilot により、コード内のコメントと、潜在する各問題の概要が表示されます。 次のことを実行できます。
- 確認し、提案に基づいて変更を行います。
- コメント ボックスの右上隅にある下向き矢印を使ってコメントを無視します。
-
すべてのレビュー コメントを削除するには、[Git Changes] ウィンドウのコード レビュー リンクの横にある をクリックします。
Visual Studio で Copilot コード レビュー を有効にして構成する方法の詳細については、Visual Studio のドキュメントの「Copilot Chat を使用してローカルな変更を確認する」を参照してください。
Copilot コード レビュー の使用
以下の手順では、GitHub Mobile で Copilot コード レビュー を使う方法について説明します。 他の一般的なコーディング環境での指示を見るには、ページの上部で適切なタブをクリックしてください。
- GitHub Mobile で pull request を開きます。
- [Review] セクションまで下にスクロールし、展開します。
- [Request Reviews] をクリックします。
- レビュー担当者として Copilot を追加した後、[Done] をクリックします。
Copilot が変更をレビューしてフィードバックを提供します。
前提条件
Xcode で Copilot コード レビュー を使うには、GitHub Copilot Chat 拡張機能のバージョン 0.41.0 以降を使う必要があります。 github/CopilotForXcode
リポジトリから最新リリースをダウンロードしてください。
Copilot コード レビュー の使用
以下の手順では、Xcode で Copilot コード レビュー を使う方法について説明します。 他の一般的なコーディング環境での指示を見るには、ページの上部で適切なタブをクリックしてください。
-
Xcode で、1 つ以上のファイルに対していくつかの変更を行います。
-
メニュー バーで [Editor] をクリックし、[GitHub Copilot]、[Open Chat] の順にクリックして、Copilot のチャット ウィンドウを開きます。
-
Copilot チャット ウィンドウのプロンプト ボックスの右下にある [Code Review] ボタン (吹き出しアイコン) をクリックします。
-
[Review Staged Changes] または [Review Unstaged Changes] をクリックします。
-
変更を含むファイルの一覧がチャット ウィンドウに表示されます。 Copilot でレビューしないファイルのチェック ボックスをクリックして選択を解除します。
-
[Continue] をクリックして、レビュー プロセスを始めます。
-
Copilot は、コメントする内容を見つけた場合、チャット ウィンドウに [Reviewed Changes] 一覧を表示して、コメントしたファイルの一覧を表示します。 コメントを表示するには、この一覧のファイルをクリックします。
各コメントが、エディターの上に重ねて表示されるポップアップで示されます。
-
ファイルに複数のコメントがある場合は、ポップアップの右上にある上下の矢印を使って、コメント間を移動します。
-
Copilot では、コードの置換が提案される場合があります。 [Accept] をクリックすると提案された変更を適用でき、[Dismiss] をクリックすると拒否できます。
-
チャット ウィンドウの [Reviewed Changes] 一覧で別のファイルをクリックすると、別のファイルのレビュー コメントが表示されます。