サイトアイコン アマチュア無線局JS2IIU

GitHub Copilotの「copilot-instructions.md」とは？

JS2IIU

こんにちは、JS2IIUです。
GitHub Copilot は、AIによるコード補完やチャット支援で開発を効率化してくれる強力なツールです。実際に使う場面では、プロジェクトごとにコーディングスタイルや使用する技術スタックが異なるため、生成AIの提案内容が期待値通りにならない可能性もあります。
このようなときに活用できるのが copilot-instructions.md です。このファイルをリポジトリに追加すると、プロジェクト固有のルールや方針を Copilot に伝えることができ、より精度の高いコード提案を受けられるようになります。
本記事では、copilot-instructions.md の役割・機能・注意点・具体的な活用方法について詳しくみていきます。今回もよろしくお願いします。

記事要約

copilot-instructions.md とは

copilot-instructions.md は、GitHub Copilot に対して追加の指示を与えるための Markdown 形式の設定ファイル です。
プロジェクトのルート直下、または .github/copilot-instructions.md に配置します。

このファイルに記述した内容は、Copilot がコード補完・チャット応答・コードレビューを行う際の 文脈情報（プロンプト） として自動的に読み込まれます。

つまり、このファイルは「Copilot に対するチームの開発ガイドライン」や「プロジェクトの前提条件」を共有するための仕組みです。

主な役割と機能

プロジェクト固有の文脈を伝える

Copilot に、プロジェクトで使用している言語やフレームワーク、ビルド方法、依存関係などを教えることができます。

例：

Markdown
This project uses Python 3.11 with FastAPI.  
Use Pydantic for data validation and Poetry for dependency management.

これにより、Copilot が「このプロジェクトではどのような技術を使うのか」を理解し、より的確なコード提案が行われます。

コーディング規約や命名ルールの統一

プロジェクト内で統一したいコーディングスタイルを指定できます。

例：

Markdown
Use 4-space indentation, snake_case for variables, PascalCase for classes, and double quotes for strings.

こうすることで、チーム内でスタイルがバラつくことを防ぎ、Copilot の提案も規約に沿ったものになります。

コードの種類ごとに規約を規定したい場合、複数のinstructionファイルを作成し、特定の拡張子のファイルの適用させることが可能です。詳細はこちらのリンク先を参照ください。

GitHub Copilot のリポジトリ カスタム命令を追加する – GitHub Docs

コードレビュー時の基準設定

Copilot のコードレビュー機能でも、copilot-instructions.md の内容が参照されます。
これにより、チーム内のレビュー基準を統一し、レビューコメントの精度を高めることができます。

コードレビュー向けの内容を記載したcopilot-instructions.mdのサンプルがこちらのリンク先にありますのでぜひ参考にしてみて下さい。

GitHub Copilot のリポジトリ カスタム命令を追加する – GitHub Docs

Copilot エージェント機能との連携

最近では、Copilot が自動で修正提案や Pull Request を生成する「エージェント機能」が登場しています。
この機能でも、copilot-instructions.mdの内容が参照されるため、テスト方法やチェックルールなどを明記しておくと、より安全な自動処理が可能になります。

注意点と制約

copilot-instructions.md を利用する際は、以下の点に注意が必要です。

  1. 指示は明確・簡潔に書く
    長文・複雑なルールはCopilotの理解を妨げます。できるだけ具体的かつ短くまとめましょう。
  2. 否定形の指示は避ける
    「〜しないでください」ではなく、「〜してください」と肯定的に書く方がAIの理解に適しています。
  3. IDEごとにサポート状況が異なる
    VS Codeでは完全対応していますが、JetBrains系IDEなどでは動作が限定される場合があります。
  4. 定期的な見直しが必要
    プロジェクト構成や使用技術の変化に合わせて、指示ファイルもアップデートしましょう。

実践的な活用方法

手順

1.  `.github` フォルダを作成
2.  その中に `copilot-instructions.md` を配置
3.  以下のように自然言語で指示を書く
4.  Copilot を起動して、提案内容が反映されているか確認

記述例

Markdown
# GitHub Copilot Instructions

This is a FastAPI project running on Python 3.11.
Use Pydantic for all request/response validation.
Follow these coding conventions:
- Use 4-space indentation.
- Use snake_case for functions and variables.
- Use PascalCase for class names.
- Use double quotes for strings.
- Include type hints in all functions.
- Write docstrings using Google style.

When suggesting tests, prefer pytest with async support.
Do not use print() for debugging; use the logging module instead.

このように書くことで、Copilot の提案があなたのチームスタイルに沿ったものになります。

効果的な運用のコツ

まとめ

copilot-instructions.md は、GitHub Copilot にプロジェクトの文脈やチームルールを伝えるための「カスタム命令ファイル」です。
導入することで、以下のような効果が期待できます。

Copilot を単なる自動補完ツールから、「チームに合わせて学習するAIアシスタント」に進化させる第一歩となるのが、この copilot-instructions.md です。

参考リンク

最後まで読んでいただきありがとうございます。
ご意見ご感想はコメント欄までぜひよろしくお願いします。

モバイルバージョンを終了