GitHub Copilotカスタムインストラクション完全ガイド - チーム開発を最適化する実践手法¶

# ❌ 非推奨: 大量のコンテキストを直接記述
コーディング規約：
1. 変数名は camelCase を使用
2. 関数名は動詞から始める
3. クラス名は PascalCase を使用
4. インデントはスペース2文字
5. 文字列リテラルはダブルクォート
6. セミコロンは省略しない
... (大量の詳細規約が続く)

# ✅ 推奨: 参照パターンを活用
コーディング規約は [coding-standards.md](./docs/coding-standards.md) を参照してください。
デバッグ手順は [debugging-guide.md](./docs/debugging-guide.md) に従って実施してください。
API設計方針は [api-design.md](./docs/api-design.md) を確認してください。

project-root/
├── .github/
│   ├── copilot-instructions.md      # メインのカスタムインストラクション
│   └── instructions/                # 追加のインストラクションファイル
│       ├── frontend.instructions.md
│       ├── backend.instructions.md
│       └── testing.instructions.md
├── docs/
│   ├── coding-standards.md          # 詳細なコーディング規約
│   ├── debugging-guide.md           # デバッグ手順
│   ├── api-design.md               # API設計ガイドライン
│   ├── deployment-guide.md         # デプロイメント手順
│   └── troubleshooting.md          # トラブルシューティング
└── README.md

# プロジェクト開発ガイドライン

## 基本方針
このプロジェクトはNext.js + TypeScript + Tailwind CSSで構築されています。

## 参照すべきドキュメント
- コーディング規約: [docs/coding-standards.md](./docs/coding-standards.md)
- API設計方針: [docs/api-design.md](./docs/api-design.md)
- テスト戦略: [docs/testing-strategy.md](./docs/testing-strategy.md)
- デプロイ手順: [docs/deployment-guide.md](./docs/deployment-guide.md)

## 技術スタック固有の指示
- TypeScriptは strict モードで使用
- Tailwind CSSのクラス名は短縮形を避け、明確なものを使用
- React Hooksは適切な依存配列を必ず指定
- エラーハンドリングは必ず実装

## ファイル命名とディレクトリ構成
- コンポーネントファイル: PascalCase.tsx
- ユーティリティファイル: camelCase.ts
- 定数ファイル: UPPER_SNAKE_CASE.ts

# 段階的な詳細レベルの提供

## レベル1: 即座に必要な情報
- 使用技術: React 18 + TypeScript + Vite
- パッケージマネージャー: pnpm（npm/yarnは使用禁止）
- コードフォーマッター: Prettier + ESLint

## レベル2: 詳細ガイドライン
- 詳細なコーディング規約: [docs/detailed-coding-standards.md](./docs/detailed-coding-standards.md)
- アーキテクチャ設計: [docs/architecture-guide.md](./docs/architecture-guide.md)

## レベル3: 特殊ケース対応
- パフォーマンス最適化: [docs/performance-guide.md](./docs/performance-guide.md)
- セキュリティガイドライン: [docs/security-guidelines.md](./docs/security-guidelines.md)

# 役割に応じた指示の分離

## フロントエンド開発
[#file:./instructions/frontend.instructions.md](./instructions/frontend.instructions.md)を参照

## バックエンド開発
[#file:./instructions/backend.instructions.md](./instructions/backend.instructions.md)を参照

## DevOps・インフラ
[#file:./instructions/devops.instructions.md](./instructions/devops.instructions.md)を参照

# プロジェクト固有の短期コンテキスト
- 現在のスプリント目標: 認証機能の実装
- 優先対応バグ: [docs/current-issues.md](./docs/current-issues.md)

# 長期的なプロジェクト方針
- プロダクト戦略: [docs/product-strategy.md](./docs/product-strategy.md)
- 技術的負債対応: [docs/technical-debt.md](./docs/technical-debt.md)

# 新人エンジニア向けオンボーディング

## 🚀 最初に読むべきドキュメント
1. [プロジェクト概要](./docs/project-overview.md) - 10分で理解できるプロジェクト全体像
2. [開発環境構築](./docs/setup-guide.md) - 環境構築の完全手順
3. [コーディング規約](./docs/coding-standards.md) - 最低限守るべきルール

## 🔧 日常開発で参照するドキュメント
- [デバッグ手順](./docs/debugging-guide.md) - 問題発生時の調査方法
- [テスト実行方法](./docs/testing-guide.md) - ローカル・CI両方のテスト手順
- [リリース手順](./docs/release-process.md) - デプロイとリリースの流れ

## 💬 質問・相談時の参考
- [FAQ](./docs/faq.md) - よくある質問と回答
- [トラブルシューティング](./docs/troubleshooting.md) - 既知の問題と解決策

# チーム開発ガイドライン

## 🔄 開発フロー
1. 機能実装前: [機能設計テンプレート](./docs/templates/feature-design.md)を作成
2. コード実装: [コーディング規約](./docs/coding-standards.md)に従う
3. テスト作成: [テスト戦略](./docs/testing-strategy.md)に基づく
4. レビュー依頼: [レビューガイドライン](./docs/review-guidelines.md)を確認

## 🚨 緊急時対応
- 本番障害: [インシデント対応手順](./docs/incident-response.md)
- セキュリティ問題: [セキュリティ対応手順](./docs/security-incident.md)

# 効果的なインストラクション例

## 技術選択の指示
- データベースクエリには Prisma ORM を使用（生SQLは避ける）
- 状態管理は Zustand を使用（Redux は使わない）
- UI コンポーネントは shadcn/ui をベースに実装

## ファイル出力の指示
- 必ず対象ファイル名を明記してコードを出力する
- 複数ファイルの変更が必要な場合は、ファイルごとに分けて表示

## エラー対応の指示
- 不明な点がある場合は推測ではなく明確に質問する
- エラー発生時は [デバッグガイド](./docs/debugging-guide.md) の手順に従う

## 参照ドキュメント
- 詳細なAPI仕様: [api-spec.yaml](./docs/api-spec.yaml)
- デザインシステム: [design-system.md](./docs/design-system.md)

# 問題のある記述例

## 外部リソース依存（避けるべき）
- スタイルガイドは https://external-site.com/styleguide を参照
- 外部の my-org/my-repo リポジトリの styleguide.md に従う

## 曖昧な指示（避けるべき）
- 「フレンドリーな同僚のスタイルで回答」
- 「1000文字以内で回答」
- 「12文字以内の単語を使用」

## コンテキスト過多（避けるべき）
大量のコーディング規約、API仕様、設計ドキュメントを直接記述...

{
  "github.copilot.chat.codeGeneration.useInstructionFiles": true,
  "github.copilot.chat.codeGeneration.instructions": [
    "プロジェクト固有の補足指示",
    "ローカル環境での特別な設定"
  ],
  "chat.instructionsFilesLocations": {
    ".github/instructions/**/*.instructions.md": true,
    "docs/instructions/**/*.md": true
  }
}

#!/bin/sh
# .git/hooks/pre-commit

# カスタムインストラクションファイルの変更をチェック
if git diff --cached --name-only | grep -q "copilot-instructions.md"; then
    echo "📝 Copilot instructions updated. Team notification recommended."
fi

# インストラクション改善サイクル

## 月次レビュー
- [ ] 新規追加された技術・ツールの反映
- [ ] チームからのフィードバック収集と対応
- [ ] 参照ドキュメントの最新性確認

## 四半期レビュー
- [ ] プロジェクト方針変更の反映
- [ ] 使用頻度の低いインストラクションの整理
- [ ] 新しいベストプラクティスの導入検討