GitHub Copilotを使用してプロジェクトを探索する

このガイドでは、 GitHubのCopilot Chat を使用してリポジトリの目的を理解し、ファイルを調べて、特定のコード行を調べる方法について説明します。これらの手順に従って行うと、プロジェクトの分析情報をいっそう速やかに得ることができ、オンボード、コードレビュー、プロジェクトの探索がさらに容易で効率的になります。

前提条件

GitHub Copilot にアクセスする必要があります。詳しくは、「GitHub Copilotとは」をご覧ください。

リポジトリの理解

初めて参加するプロジェクトの場合、リポジトリとそのファイルの目的を理解するのに苦労することがあります。 Copilot は、リポジトリの README ファイルの概要を提供するなどして、リポジトリの目的をすばやく理解するのに役立ちます。

GitHub Web サイトで、チャットするリポジトリに移動します。
ページの右上にあるアイコンをクリックします。
チャットパネルの上部にある見出しには、[Chatting about] の後に現在のリポジトリの名前が表示されます。

以前に別のリポジトリについてチャットしていたために間違ったリポジトリ名が表示されている場合は、[すべてのリポジトリ] をクリックし、チャットするリポジトリを選択します。
[Ask Copilot] ボックスのチャットパネルの下部に、「README に基づいてこのリポジトリの目的を要約する」と入力し、 Enter キーを押します。
Copilot チャットパネルで応答します。

Copilotを使用して、リポジトリ内のさまざまなフォルダーとファイルの役割を理解することもできます。たとえば、特定のファイルの内容を要約したり、特定のフォルダーの目的を説明したりするように Copilot に依頼できます。

ファイルとコードの探索

プロジェクトを探索するとき、特定のファイルの内容を理解したいことがあります。 Copilot は、ファイルの内容の概要を提供するなどして、ファイルの目的をすばやく理解するのに役立ちます。 Copilotに、ファイル内の特定のコード行について説明するように依頼することもできます。

GitHub で、リポジトリに移動し、ファイルを開きます。
次のいずれかの操作を行います。
- ファイル全体について質問するには、ファイルビューの右上にある [Copilot] アイコン () をクリックします。
- ファイル内の特定の行について質問するには:
  1. 質問したい最初の行の行番号をクリックし、Shift キーを押しながら選択する最後の行の行番号をクリックします。
  2. 選んだ行について独自の質問をするには、選択部分の右側にある [Copilot] アイコン () をクリックしてから、ギットハブコパイロットチャットパネルに質問を入力します。
  3. 定義済みの質問をするには、Copilot アイコンの横にあるドロップダウンメニューをクリックして、いずれかのオプションを選びます。
[Copilot] アイコンをクリックしたら、チャットパネルの下部にある [Ask Copilot] (Copilot に質問する) ボックスに質問を入力し、Enter キーを押します。

たとえば、ファイル全体について質問する場合は、次のように入力できます。
- Explain this file.
- How could I improve this code?
- How can I test this script?
特定の行について質問する場合は、次のように入力できます。
- Explain the function at the selected lines.
- How could I improve this class?
- Add error handling to this code.
- Write a unit test for this method.
Copilot は、パネル内のリクエストに応答します。
必要に応じて、質問を送信した後、テキストボックス内のをクリックして回答を停止できます。
フォローアップの質問をして、会話を続けることができます。たとえば、「tell me more」(もっと詳しく) と入力することで、Copilot を取得して最新のコメントを展開できます。

参考資料

GitHub Copilot を使用してコードベースを探索する

次のステップ

Copilotを使用してプロジェクトを探索する方法を理解したら、それを使用して、GitHubのリポジトリ、ファイル、またはコード行を理解するのに役立ちます。