Devin 向けの AGENTS.md ファイル - Devin Docs

Devin は AGENTS.md をサポートしています。これは、AI エージェントに前提情報と指示を提供するための、シンプルでオープンな標準です。AGENTS.md は、エージェント向けの README のようなものと考えてください。

AGENTS.md ファイルの作成

プロジェクトのルートディレクトリ (または任意の場所) に AGENTS.md ファイルを置くだけです。Devin はコーディングを開始する前にこのファイルを探します。 Devin は、各 AGENTS.md ファイルの先頭から最大 16 KiB (16,384 バイト) を自動的に前提情報に取り込みます。これより長いファイルの場合、Devin には切り捨ての通知が届き、必要に応じてファイル全体を読み込めますが、上限を超えた部分の指示は自動的には取り込まれません。重要な指示はファイルの先頭付近に記述し、常時適用のガイダンスは 16 KiB 以内に収め、長いガイダンスや特定の状況でのみ必要なガイダンスはスキルまたは参照ファイルに移してください。次に例を示します。

# AGENTS.md

## セットアップコマンド
- 依存関係のインストール：`npm install`
- 開発サーバーの起動：`npm run dev`
- テストの実行：`npm test`
- 本番環境用ビルド：`npm run build`

## コードスタイル
- TypeScript strict モードを使用する
- React では関数コンポーネントを優先する
- ESLint と Prettier の設定を使用する
- Conventional Commit 形式に従う

## テストガイドライン
- すべての新規関数にユニットテストを作成する
- テストフレームワークには Jest を使用する
- コードカバレッジ 80% 以上を目指す
- コミット前にテストを実行する

## プロジェクト構造
- `/src` - メインアプリケーションコード
- `/tests` - テストファイル
- `/docs` - ドキュメント
- `/public` - 静的アセット

## 開発ワークフロー
- `main` から機能ブランチを作成する
- コードレビューにはプルリクエストを使用する
- マージ前にコミットをスカッシュする
- 新機能のドキュメントを更新する

また、Devin にリポジトリでの作業方法についての前提情報を与えるために、リポジトリのセットアップを行うことも強く推奨します。