.github/copilot-instructions.md とは
.github/copilot-instructions.md は、GitHub Copilot に「このリポジトリではこうしてほしい」というリポジトリ固有の指示(repository custom instructions)を与えるためのファイルです。
個人設定(Personal instructions)と違い、リポジトリにコミットされるので、チーム全員が同じ前提で Copilot を使えるようになります。
作り方
いくつかの作り方があります。
- ゼロから作成する
- VS Code の機能で作成する
- コマンドパレット>「チャット: ワークスペース指示ファイルを生成する」
- Use custom instructions in VS Code
効果があるところ
.github/copilot-instructions.md は GitHub.com だけではなく、VS Code など複数の環境で参照されます。
ただし、環境や機能(Chat / Code review / Agent)によって「どの種類の指示がサポートされているか」が異なります。
対応表は公式のリファレンスが最も確実です。
参考:Awesome Copilot
カスタム指示を作るときに、私は github/awesome-copilot のリポジトリを参考することが多いです。
ここからベースとなる指示をコピーしてきて、プロジェクトに合わせてカスタマイズします。
.github/copilot-instructions.md の表示箇所
リポジトリに .github/copilot-instructions.md ファイルがある場合に、特別な表示になる箇所はおそらくありません。
※ VS Code やサポートしている IDE であれば、Copilot を使うときにこのファイルの内容が参照されるようになります。
まとめ
.github に配置できるファイルの一覧はこちらの記事でまとめています。