GitHub CopilotとAGENTS.mdの活用方法 - コーディングエージェント向け指示ファイル完全ガイド

1
2
3
4
5
6
7
8

# ディレクトリ構造の例
your-project/
├── AGENTS.md           # エージェント向け指示ファイル
├── .github/
│   └── copilot-instructions.md  # Copilot専用のコーディング規約
├── src/
├── tests/
└── README.md

1
2
3
4
5
6
7

# AGENTS.md

## Project Overview

このリポジトリはTypeScriptで構築されたWebアプリケーションです。
フロントエンドにNext.js 15、バックエンドにNode.js + Honoを使用しています。
データベースはPostgreSQLで、ORMとしてPrismaを採用しています。

1
2
3
4
5
6

## Setup Commands

- 依存関係のインストール: `pnpm install`
- データベースのマイグレーション: `pnpm prisma migrate dev`
- 開発サーバーの起動: `pnpm dev`
- 本番ビルド: `pnpm build`

1
2
3
4
5
6
7
8
9

## Testing Instructions

- 全テストの実行: `pnpm test`
- 特定のテストのみ実行: `pnpm test -- --grep "テスト名"`
- カバレッジ付き実行: `pnpm test:coverage`
- E2Eテスト: `pnpm test:e2e`（要: Docker環境）

テストを追加または変更した場合は、必ず `pnpm lint` でコードスタイルを確認してください。
コミット前に全テストがパスすることを確認してください。

1
2
3
4
5
6
7
8

## Project Structure

- `src/app/` - Next.jsのApp Routerページコンポーネント
- `src/components/` - 再利用可能なUIコンポーネント
- `src/lib/` - ユーティリティ関数とヘルパー
- `src/server/` - バックエンドAPIハンドラ
- `prisma/` - データベーススキーマとマイグレーション
- `tests/` - ユニットテストとE2Eテスト

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

## CI/CD Information

GitHub Actionsで以下のチェックが実行されます：

1. `pnpm lint` - ESLintとPrettierによるコードスタイルチェック
2. `pnpm type-check` - TypeScriptの型チェック
3. `pnpm test` - Vitestによるユニットテスト
4. `pnpm build` - 本番ビルドの成功確認

Pull Requestを作成する前に、これらすべてのチェックがローカルで通過することを確認してください。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

# AGENTS.md

## Project Overview

このリポジトリはNext.js 15とTypeScriptで構築されたWebアプリケーションです。
パッケージマネージャーにはpnpmを使用しています。

## Setup Commands

- 依存関係のインストール: `pnpm install`
- 開発サーバーの起動: `pnpm dev`（http://localhost:3000）
- 本番ビルド: `pnpm build`
- 本番サーバーの起動: `pnpm start`

## Testing Instructions

- ユニットテスト: `pnpm test`
- ウォッチモード: `pnpm test:watch`
- カバレッジ: `pnpm test:coverage`

コードを変更した場合は、関連するテストも追加または更新してください。

## Code Style

- TypeScript strict modeを有効化
- シングルクォートを使用
- セミコロンなし
- 関数型プログラミングパターンを推奨

## Project Structure

- `src/app/` - ページコンポーネント（App Router）
- `src/components/` - 再利用可能なUIコンポーネント
- `src/lib/` - ユーティリティ関数
- `src/types/` - 型定義ファイル

## PR Guidelines

- PRタイトルは `feat:`, `fix:`, `docs:` などのConventional Commitsプレフィックスを使用
- コミット前に `pnpm lint` と `pnpm test` を実行

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

# AGENTS.md（ルート）

## Monorepo Overview

このリポジトリはTurborepoで管理されたモノレポです。

## Package Navigation

- パッケージに移動: `pnpm dlx turbo run where <package_name>`
- 特定パッケージの依存関係インストール: `pnpm install --filter <package_name>`

## Testing

- 全パッケージのテスト: `pnpm turbo run test`
- 特定パッケージのテスト: `pnpm turbo run test --filter <package_name>`

## Packages

- `packages/ui` - 共有UIコンポーネントライブラリ
- `packages/config` - 共有設定ファイル
- `apps/web` - Webアプリケーション
- `apps/api` - APIサーバー

各パッケージの詳細は、パッケージディレクトリ内のAGENTS.mdを参照してください。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

# AGENTS.md（packages/ui）

## Package Overview

このパッケージは共有UIコンポーネントライブラリです。
React 18とTailwind CSSを使用しています。

## Development

- Storybookの起動: `pnpm storybook`
- ビルド: `pnpm build`
- テスト: `pnpm test`

## Component Guidelines

- 各コンポーネントは独立したディレクトリに配置
- Storybookストーリーを必ず追加
- PropsはTypeScriptのinterfaceで型定義

1
2
3
4
5
6
7
8

your-project/
├── AGENTS.md                    # ルートの指示
├── packages/
│   ├── ui/
│   │   ├── AGENTS.md            # packages/ui配下で優先される
│   │   └── src/
│   └── api/
│       └── src/                 # packages/api配下ではルートのAGENTS.mdが使用される

1
2
3

このリポジトリを分析して、.github/copilot-instructions.mdファイルを作成してください。
ビルド手順、テスト方法、コーディング規約を調査し、エージェントが効率的に作業できる
指示ファイルを生成してください。

1
2

## Testing
テストを実行してください。

1
2
3
4

## Testing
- ユニットテスト: `pnpm test`
- 特定のファイルのみ: `pnpm test src/utils/format.test.ts`
- カバレッジ付き: `pnpm test -- --coverage`

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

## Prerequisites

- Node.js 20以上が必要です
- pnpmは `corepack enable` で有効化してください

## Common Issues

### `pnpm install` が失敗する場合
Node.jsのバージョンを確認してください。`nvm use 20` でバージョンを切り替えられます。

### テストがタイムアウトする場合
Dockerが起動していることを確認してください。E2Eテストはデータベースコンテナを使用します。