概要
.github/copilot-instructions.md ファイルを作成すると、Copilot Chat がプロジェクト全体でそのルールを参照します。チーム全体で一貫したコード生成が可能になります。
設定ファイルの作成手順
- リポジトリルートに
.github/ディレクトリを作成する copilot-instructions.mdファイルを作成して自然言語でルールを記述する- 使用言語・フレームワーク・スタイルガイドの URL などを明記する
- 避けるべきパターン（例:
varの使用禁止、any 型の禁止）も記述する - ファイルをコミットしてチームで共有する（
@workspace利用時に自動参照される）
効果的なルール記述の例
- 「TypeScript を使用し、
any型は使わないでください」 - 「エラーハンドリングには必ず Result 型パターンを使用してください」
- 「テストフレームワークは Vitest を使用し、AAA パターンで記述してください」
- 「コメントは日本語で記述してください」