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

はじめに

よく知らないプロジェクトでの作業に割り当てられた場合、またはコントリビュートしたい興味深いオープンソースプロジェクトが見つかった場合は、変更を始める前に、コードベースをある程度理解しておく必要があります。このガイドでは、GitHub Copilot チャットを使ってコードベースを調べて、プロジェクトのことを短時間で理解する方法について説明します。

Copilot チャットを使って作業する

このガイド全体を通して、Copilot チャットを GitHub.com で操作します。github.com/copilot で見つけることができます。

コードベースを接続する

Copilot チャットが役立つ前に、探索するコードベースを接続しなければなりません。

GitHub で、 github.com/copilot に移動します。
テキストボックスで、[ [リポジトリ、ファイル、スペースの追加] をクリックし、[ リポジトリ] をクリックします。
探索するリポジトリを検索して選択します。

Copilot チャットはそのリポジトリ内のコードにアクセスできるようになり、そのリポジトリに関する質問を開始できます。

プロンプトの例

以下のプロンプトは、Copilot に質問できて、コードベースについて調べるのに役立つ質問の種類の例です。

一般的な質問

Based on the code in this repository, give me an overview of the architecture of the codebase. Provide evidence.
Which languages are used in this repo? Show the percentages for each language.
What are the core algorithms implemented in this repo?
What design patterns are used in this repository? Give a brief explanation of each pattern that you find, and an example of code from this repository that uses the pattern, with a link to the file.

具体的な質問

これらの質問が役に立つかどうかは、調べているコードベースによります。

How do I build this project?
Where is authentication handled in this codebase?
Analyze the code in this repository and tell me about the entry points for this application.
Describe the data flow in this application.
Analyze the code in this repository and tell me what application-level security mechanisms are employed. Provide references.

ディレクトリ内のファイルについて

Copilot を使うと、ディレクトリ内のファイルまたは個々のファイルの目的を理解するのに役立ちます。

ディレクトリ内のファイルについて調べるには:

GitHub.com でディレクトリに移動します。
ページの右上隅にある Copilot アイコン () をクリックして、 Copilot チャットを開きます。

Copilot は、ディレクトリの内容を質問の背景として使用します。
Copilot に次のように質問します: Explain the files in this directory。

特定のファイルについて調べるには:

GitHub.com でファイルを開きます。
ページの右上隅にある Copilot アイコン () をクリックして、 Copilot チャットを開きます。

Copilot は、質問の文脈としてファイルの内容を利用します。
小さいファイルの場合は、Copilot に次のように質問します: Explain this file。
大きいファイルの場合は、次のように質問します: Explain what this file does. Start with an overview of the purpose of the file. Then, in appropriately headed sections, go through each part of the file and explain what it does in detail.

特定のコード行について理解する

Copilot を使うと、ファイル内の特定のコード行について理解できます。

特定のコード行について調べるには:

GitHub で、リポジトリに移動し、ファイルを開きます。
選択する最初の行の行番号をクリックし、Shift キーを押しながら選択する最後の行の行番号をクリックして、行を選択します。
選択した行について独自の質問をするには、選択した行の右側にある [Copilot] アイコン () をクリックします。これにより、選択した行が質問のコンテキストとして示された GitHub Copilot チャットパネルが表示されます。
定義済みの質問をするには、Copilot アイコンの横にある下向きのボタンをクリックし、オプションのいずれかを選択します。
Copilot アイコンをクリックした場合は、チャットパネルの下部にあるプロンプトボックスに質問を入力して、Enter キーを押します。

特定のファイルまたはシンボルについて理解する

Copilot を使うと、コードベース内の特定のファイルまたはシンボルの目的を理解できます。シンボルは、関数、クラス、変数などのコード内の名前付きエンティティです。

GitHub で、リポジトリに移動し、ファイルを開きます。
ファイルの上部にある Copilot アイコン () をクリックして、 Copilot チャットを開きます。

Copilot は、質問に対するコンテキストとして画面を分割してファイルの内容を表示します。
特定のシンボルについて質問する場合は、ファイル内のシンボルを強調表示します。
プロンプトボックスに、ファイルまたは強調表示された記号に関する質問を入力し、 Enter キーを押します。

Copilot はチャットパネルで応答します。

ヒント

リポジトリのセマンティックコード検索インデックスが最新の場合、リポジトリコンテキストでこのような自然言語の質問に答える Copilot の機能は最適化されます。詳しくは、「GitHub Copilot Chat のためのリポジトリのインデックス作成」をご覧ください。

コミットについて調べる

プロジェクトについての理解を深めるのに良い方法の 1 つは、最近行われている作業を調べることです。これを行うには、最近のコミットを参照します。

GitHub で、リポジトリのメインページに移動します。1. リポジトリのメインページで、ファイルリストの上にある [ commits] をクリックします。
コミットメッセージをクリックして、そのコミットの差分ビューを表示します。
Copilot チャットパネルに「What does this commit do?」と入力します。
必要な場合は、「Explain in more detail」と入力してフォローアップできます。

[Insights] タブの使用

プロジェクトについての理解を深めるには、Copilot を使うだけでなく、GitHub.com の [Insights] タブを使うこともできます。これにより、リポジトリの概要が表示されます。

詳細については、「Pulse を使用してリポジトリアクティビティの概要を表示する」および「プロジェクトのコントリビューターを表示する」を参照してください。

参考資料

        [AUTOTITLE](/copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-github)

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

この記事の内容