copilot-instructions.md の作り方

はじめに

copilot-instructions.md が何かは割愛します。
copilot-instructions.md をどう作り始めるのかについて、簡潔に記載します。

作成

copilot-instructions.md が何者かは、Copilot は知っています。
知っているというか、自分で調べて理解できます。
なので、あなたが構築するシステム/プログラムなどについて、特徴的なことをプロンプトに書いて、作成依頼するだけで作れます。

プロンプト雛形例

下記はソースのみのリポジトリを想定しています。ドキュメントも格納するなら、ドキュメントの形式などについても触れること。（OpenAPI yml でとか、asciidoc とか、mermaid or plantuml とか）

.gihub/ 直下に copilot-instructions.md を作って保存してください。
条件は以下のとおりです。

｛下記を参考にあなたが複数行のプロンプトを記載する。箇条書きとかで充分。｝
｛全部書けなくてもいい。書けるところだけでも書いて、書けない部分は削除していいので、まずは作らせる。｝

- システムの概要（誰が使う、どんなものか）
- 実行環境
  - OS
  - システム構成（軽めに）
- 各種技術スタック
  - 開発環境
  - 開発言語
  - 利用するフレームワーク
- コーディング規約
  - xxxx に準拠
- ファイル構成
  - 主要なディレクトリ構造を列挙
- 注意事項
  - セキュリティ
    - xxxxx
  - パフォーマンス
    - xxxx
  - テスト
    - xxxx
- レビュールール
  - 指摘は日本語で行う
  - 曖昧な表現を避け、抽象的な指摘の場合は具体的な例を挙げる
  - 問題の深刻度レベルを明示する
    - Critical: セキュリティ脆弱性、クラッシュ原因となる問題
    - Major: 機能不全、パフォーマンス問題、重大なバグ
    - Minor: コーディング規約違反、軽微な改善提案

1. プロンプト雛形例を参考に書ける部分だけでいいので、まずは作成依頼プロンプトを書いてみる。
2. その際、実行環境／技術スタックあたりは、利用するバージョンなどまで厳密に書くとなおよい。
3. Agentモードで Copilot Chat に作成したプロンプトを投げて、まずは新規に作成させる。
4. 作成されたものをセルフレビューして、書き足したり、削除したりして見直す。
5. 見直したものを、Copilot Chat でレビューする。適切か？矛盾はないかなど。
6. できたら、commit / push する。
7. 運用をしながら、適宜見直す。

おまけ

• レビューについて書く場合、必ず「日本語で出力」などと書いておきましょう。
• 公式 によると、命令ファイルが長すぎます (1,000 行を超える)。 のような記述が見られるので、1,000行を超えないようにしましょう。（1,000行は目安だと思われるので、実際はもう少し抑えたほうがよいと思います。）
• 実際に運用開始する際には、プロジェクトメンバーにも必ず一読させましょう。Copilot は知っているのに、メンバーが知らないのは草。