AGENTS.md 設定ガイド

your-project/
  AGENTS.md          <- リポジトリレベルの設定
  src/
  tests/
  package.json

# AGENTS.md

- コードはすべて TypeScript の strict モードで書くこと
- 整形は Prettier、静的解析は ESLint を使う
- テストは Vitest を使い、`__tests__/` ディレクトリに置く
- タスク完了前に `npm run lint && npm test` を実行する
- `vendor/` ディレクトリのファイルは変更しない
- API レスポンスは標準のエンベロープ形式に従う：`{ code, data, message }`

# AGENTS.md

## コード規約

- TypeScript の strict モードを使う
- 変数は camelCase、型は PascalCase
- 1 つの関数は 50 行以内に収める

## テスト要件

- 単体テストのカバレッジ目標は 80%
- テストファイルはソースと同名 + `.test.ts`
- 外部依存はモックする。テスト内で実ネットワークへ出ない

## 禁止事項

- `any` 型を使わない
- DOM を直接操作しない（React の状態管理を使う）
- ループ内で `await` しない（`Promise.all` を使う）

# グローバル AGENTS.md

## 共通規約

- コードコメントは英語で書く
- Git のコミットメッセージは Conventional Commits に従う
- パスワード・キー・トークンをソースに直接書かない
- 新しいコードを書く前に既存の関連コードを読み、一貫性を保つ
- 変更の影響が不明なときは、憶測せずコメントで説明を残す

## 出力の好み

- 既存の依存関係を優先し、不要な新規依存は入れない
- エラーハンドリングは徹底する。例外を黙って握り潰さない
- ログメッセージは意味のあるものにし、文脈を含める

# AGENTS.md

## プロジェクト概要
TypeScript で作られた React + Node.js のフルスタック EC プロジェクト。

## 技術スタック

- フロントエンド：React 19 + TailwindCSS + Zustand
- バックエンド：Node.js + Fastify + Prisma
- データベース：PostgreSQL 16
- テスト：Vitest + Playwright

## コード規約

- コンポーネントファイルは PascalCase：`UserProfile.tsx`
- ユーティリティ関数は camelCase：`formatDate.ts`
- API ルートは kebab-case：`/api/user-orders`
- データベースのフィールドは snake_case：`created_at`

## ディレクトリ構成

- `src/components/` - React コンポーネント
- `src/pages/` - ページコンポーネント
- `src/api/` - バックエンドの API ルート
- `src/lib/` - 共有ユーティリティ
- `prisma/` - データベーススキーマとマイグレーション

## コマンド

- `npm run dev` - 開発サーバーを起動
- `npm run build` - 本番ビルド
- `npm test` - すべてのテストを実行
- `npm run lint` - 静的解析
- `npx prisma migrate dev` - データベースマイグレーション

your-project/
  AGENTS.md                  <- プロジェクトレベルのルール
  src/
    components/
      AGENTS.md              <- コンポーネントディレクトリのルール
    api/
      AGENTS.md              <- API ディレクトリのルール

# コンポーネント規約

- すべて関数コンポーネントにする（クラスコンポーネント禁止）
- Props は TypeScript の interface で定義する
- すべてのコンポーネントに displayName を付ける
- スタイルは TailwindCSS を使い、インラインスタイルは書かない
- 複雑なコンポーネントは分割し、1 ファイル 200 行以内に収める
- 再利用可能なコンポーネントは `ui/` サブディレクトリに置く

# API 規約

- すべてのエンドポイントでリクエストパラメータを検証する（Zod スキーマ）
- エラー形式を統一する：`{ code: number, message: string, details?: any }`
- データベース操作はトランザクション内で行う
- 重要な操作は監査ログに残す
- ページネーションはカーソル方式を使う

グローバル（~/.codex/AGENTS.md）
  | リポジトリレベルが上書き
リポジトリルート（project/AGENTS.md）
  | サブディレクトリが上書き
サブディレクトリ（project/src/api/AGENTS.md） <- 最優先

# AGENTS.md

## プロジェクト情報
React 19 + TypeScript + TailwindCSS のフロントエンドプロジェクト。

## コード規約

- 関数コンポーネント + Hooks を使う。クラスコンポーネントは禁止
- 状態管理は Zustand。Redux は導入しない
- スタイルは TailwindCSS。CSS ファイルは作らない
- src 配下の参照には `@/` のパスエイリアスを使う
- コンポーネントの Props は `{ComponentName}Props` という interface で定義する

## ファイル命名

- コンポーネント：PascalCase（`UserAvatar.tsx`）
- Hook：camelCase + use プレフィックス（`useAuth.ts`）
- ユーティリティ：camelCase（`formatDate.ts`）
- 定数：camelCase（`apiEndpoints.ts`）

## コンポーネントのルール

- Props の型とコンポーネント本体の両方をエクスポートする
- 純粋な表示コンポーネントは `React.memo` で包む
- イベントハンドラーは `handle{EventName}` と命名する
- render 内で新しいオブジェクトや関数を作らない

## テスト

- フレームワーク：Vitest + React Testing Library
- テストファイルは `__tests__/` ディレクトリに置く
- 実装詳細ではなくユーザーの振る舞いをテストする
- 実行コマンド：`npm test`

## 依存関係の管理

- 新しい依存を追加する前に、既存で足りないか確認する
- 軽量なライブラリを優先する
- すべての依存に TypeScript の型定義があること

# AGENTS.md

## プロジェクト情報
Python 3.12 + FastAPI + SQLAlchemy のバックエンドサービス。

## コード規約

- 型注釈：すべての引数と戻り値に型注釈を付ける
- 非同期優先：すべての IO は async/await で書く
- Docstring：公開関数はすべて Google スタイルの docstring を書く
- import 順：標準ライブラリ → サードパーティ → ローカル（isort で管理）

## ディレクトリ構成

- `app/api/` - API ルート（機能ごとの router に分ける）
- `app/models/` - SQLAlchemy のデータモデル
- `app/schemas/` - Pydantic のリクエスト / レスポンスモデル
- `app/services/` - ビジネスロジック層
- `app/core/` - 設定、セキュリティ、依存性注入
- `tests/` - テスト。app のディレクトリ構成を鏡写しにする
- `alembic/` - データベースマイグレーション

## コーディング規約

- ルート関数の命名：`get_users`、`create_order`（動詞_名詞）
- Service 層のメソッドはルート関数に対応させる
- データモデルのフィールドは snake_case
- データベース操作はすべて Service 層を通す。ルートから ORM を直接触らない
- 機密データ（パスワード、トークン）はログやレスポンスに絶対に出さない

## エラーハンドリング

- 業務例外はカスタム Exception クラスにする
- 例外ハンドラーを統一し、標準形式で返す：`{"code": int, "message": str}`
- データベース操作は try/except で IntegrityError などを捕捉する
- 裸の except は使わない

## テスト

- フレームワーク：pytest + pytest-asyncio + httpx
- fixture でテスト用データベースとクライアントを管理する
- 実行コマンド：`pytest -v --cov=app`
- カバレッジ目標：80% 以上

## 環境管理

- 設定は .env ファイルに置き、pydantic-settings で読み込む
- 環境ごとの差分は環境変数の上書きで扱う
- データベース接続文字列やシークレットをコードに直接書かない

# AGENTS.md

## プロジェクト情報
フルスタック Web アプリ：Next.js 15 フロントエンド + API Routes + PostgreSQL。
Turborepo で管理する monorepo 構成。

## ディレクトリ構成

- `apps/web/` - Next.js フロントエンド
- `apps/api/` - 独立した API サービス（Node.js + Fastify）
- `packages/ui/` - 共有 UI コンポーネントライブラリ
- `packages/types/` - 共有 TypeScript 型
- `packages/utils/` - 共有ユーティリティ関数
- `packages/db/` - データベーススキーマ（Drizzle ORM）

## 共通規約

- 言語：TypeScript strict モード
- 整形：Prettier（ルートで設定）
- Lint：ESLint（ルートで設定）
- コミット前に実行：`turbo lint test`

## フロントエンド規約（apps/web/）

- Pages Router ではなく App Router を使う
- Server Components を優先し、必要なときだけ Client Components にする
- データ取得は Server Actions か Route Handlers 経由
- スタイルは TailwindCSS
- 画像は next/image コンポーネントを使う

## API 規約（apps/api/）

- RESTful 設計。URL は kebab-case
- リクエスト検証は Zod
- レスポンス形式：`{ success: boolean, data?: T, error?: string }`
- 認証は JWT。ミドルウェアで検証する
- レート制限のルールはルートのデコレーターに書く

## データベース規約（packages/db/）

- Drizzle ORM を使い、スキーマは `schema/` ディレクトリに定義する
- マイグレーションコマンド：`pnpm db:migrate`
- 命名：テーブル名は複数形（`users`）、フィールドは snake_case
- すべてのテーブルに `created_at` と `updated_at` を持たせる
- 論理削除は `deleted_at` フィールドで表す

## 共有パッケージの規約

- パッケージ間は workspace 経由で参照する
- 共有の型定義は `packages/types/` に置く
- パッケージから apps を import しない

your-project/
  AGENTS.md          <- Codex が読む
  CLAUDE.md          <- Claude Code が読む
  src/
  ...

# AGENTS.md

> このプロジェクトは Codex と Claude Code の両方を使います。中核の規約は以下です。
> Claude Code のユーザーは CLAUDE.md も参照してください。

## 中核の規約
（共有する内容）

git add AGENTS.md
git commit -m "feat: add AGENTS.md for Codex configuration"

<!-- PR の説明 -->
## 変更概要
AGENTS.md の更新：

- API のページネーション規約を追加（カーソル方式）
- コンポーネント内での直接の fetch 呼び出しを明示的に禁止
- ログ形式の要件を追加

## 効果の高い指示（Codex が確実に従う）

- 明確な形式指定：コンポーネントのファイル名は PascalCase にする
- 明確な禁止：any 型を使わない
- 実行コマンド：タスク完了後に npm test を実行する
- ファイル配置のルール：テストファイルは __tests__ ディレクトリに置く
- 依存関係の制約：新しい npm パッケージを入れず、既存の依存を使う

## 効果の低い指示（避けたほうがよい）

- 曖昧すぎる：良いコードを書く
- 主観的：ベストプラクティスに従う
- 範囲外：ユーザー体験を考慮する（AI は UI を動かせない）
- 矛盾：性能を優先 + 可読性を優先（優先順位を明示する必要がある）

## ファイル種別ごとのルール

### *.test.ts ファイル

- 1 つの describe ブロックにテストは 10 個まで
- テストデータはファクトリー関数で作る。ハードコードしない
- 非同期テストにはタイムアウトを設定する

### *.api.ts ファイル

- リクエストパラメータを必ず検証する
- エラーハンドリングを必ず入れる
- 戻り値に型注釈を付ける

### migrations/*.sql ファイル

- 直接編集しない。ORM のマイグレーションツールで生成する

cp CLAUDE.md AGENTS.md

## コードスタイル

このプロジェクトでは Google の TypeScript スタイルガイドに従います。変数名は
すべて camelCase、クラス名は PascalCase を使います。列挙型の値は
SCREAMING_SNAKE_CASE を使う点に注意してください。import 文の順序は、まず
Node.js の組み込みモジュール、次にサードパーティのパッケージ、最後にローカル
モジュールとし、それぞれのグループの間に空行を入れます。

## コードスタイル

- Google の TypeScript スタイルガイドに従う
- 変数：camelCase
- クラス：PascalCase
- 列挙型の値：SCREAMING_SNAKE_CASE
- import 順：組み込みモジュール → サードパーティ → ローカル（グループ間は空行）

## Codex 固有の設定

- ファイル変更がすべて終わったら `npm run lint && npm test` を実行して検証する
- テストが失敗したら自動で修正し、再実行する
- .env と .env.local は変更しない

# AGENTS.md が TypeScript を要求している前提
codex "hello world 関数を作って"

# AGENTS.md が効いていれば、Codex は .js ではなく .ts ファイルを生成します

# CLAUDE.md

@AGENTS.md

## Claude Code 固有の追加

- タスクに応じて `/model` で Sonnet 4.6 / Opus 4.8 を切り替える
- 大きな変更の前には `/plan` を実行する
- 無関係なタスクの間は `/clear`、長いセッションの区切りでは `/compact` を使う