ディレクトリ構成

プロジェクトのディレクトリ構成をAIに伝えることで、AIがファイル生成やコード参照を行う際に、適切なパスを推測しやすくなります。

これによりAIが新しいファイルを作成する際に、プロジェクトのルールから外れた場所にファイルを配置してしまう、といった事態を防ぐことができます。

以下は、プロジェクトのディレクトリ構成に関するインストラクションファイルの記述例です。

---
applyTo: "**"
---

# ディレクトリ構成

このプロジェクトは、一般的なJavaアプリケーションの構成に従います。

| パス                 | 概要                               |
|:---------------------|:-----------------------------------|
| `docs`               | 設計書などのドキュメント           |
| `src/main/java`      | アプリケーションのソースコード     |
| `src/main/resources` | 設定ファイルや各種リソースファイル |
| `src/test/java`      | テストコード                       |
| `src/test/resources` | テスト用の設定ファイルやデータ     |

このようなインストラクションファイルを、.github/instructions/directory-structure.instructions.mdのようなファイル名で作成します。これにより、GitHub Copilotはプロジェクトのディレクトリ構成を理解し、より適切な開発支援ができるようになります。

ここではプロジェクト全体のディレクトリ構成について説明しました。一方、src/main/java配下などのソースコードのパッケージ構成については、別途インストラクションファイルで定義することが効果的です。詳しくは「クラスのステレオタイプとパッケージ構成」を参照してください。