直接回答
AGENTS.md は永続的なリポジトリアナウンスであり、百科事典ではありません。関連タスクのたびに読み込む価値のあるルールだけを残し、ネストされたファイルでスコープを絞ります。
このガイドで解決できること
Codex CLI 向けの適切な AGENTS.md を作成・保守する
AGENTS.md を恒久的なプロジェクト規約として使う
一回限りのタスク要件は現在のプロンプトに残し、タスクをまたいで常に有効なリポジトリの事実だけを AGENTS.md に記載する。典型的な内容は権威あるビルドコマンド、ディレクトリの境界、コーディング規約、検証ステップ、改変禁止の生成ファイルである。
それはモデルの意思決定を導くものであり、フォーマッタや権限ポリシー、CI の代わりにはならない。必ず強制すべきルールは、テスト、lint、サンドボックス、hook によって機械的に保証されるべきである。
実行可能な最小テンプレートから始める
良いルールは具体的で短く、検証可能である。「高品質を保つ」のような実行不能な標語は書かず、ディレクトリ、コマンド、判断基準を明記する。
以下のテンプレートは構造の例示にすぎない。リポジトリの実際のコマンドに差し替えてから、チームのレビューに提出すること。存在しないコマンドはすべてのタスクを継続的に誤誘導する。
# Repository Guide
## Scope
- Work only in the module named by the task.
- Do not edit generated files under `dist/`.
## Commands
- Install: `<project-install-command>`
- Test: `<project-test-command>`
- Typecheck: `<project-typecheck-command>`
## Conventions
- Follow patterns in the nearest existing module.
- Keep API changes backward compatible unless explicitly approved.
## Verification
- Run the narrow test first, then the required repository checks.
- Report commands run and any checks that could not be completed.ネストされたファイルでディレクトリ単位のルールを表現する
リポジトリのルートファイルはグローバル規約を記述し、サブディレクトリ内の AGENTS.md はそのサブツリー特有のルールのみを補足する。対象ファイルに近い指針ほどより具体的なスコープに対応し、ルートファイルにフロントエンド、バックエンド、モバイルの全詳細を堆積させない。
衝突が生じた場合は、モデルにチームの意図を推測させようとするのではなく、まずドキュメントの矛盾を取り除く。相互に矛盾するコマンドを異なる階層に残すと、タスクの挙動が不安定になる。
find .. -name AGENTS.md -print
git status --short
git log -n 5 -- AGENTS.md価値の高い事実を記録し、文書全体を複製しない
各項目は「これを読み込まなければ、Codex は間違える可能性が高いか」に答えるべきである。長大な API リファレンス、たまに使うリリース手順、特定種類の専用タスクは、ドキュメントへリンクするか、必要に応じて読み込む Skill として整理するのに適している。
ビルドとテストコマンドには適用範囲を明記する。例えばフロントエンドの変更で何だけを実行するか、共有プロトコルの変更ではさらに何を実行するか。これにより毎回すべてのチェックを実行することも、モジュール間の契約を見落とすことも避けられる。
- リポジトリ構造とモジュールの所有権。
- インストール、ビルド、テスト、lint の権威あるコマンド。
- 公開 API、データベース、依存関係変更の承認境界。
- シークレット、生成ファイル、マイグレーションファイルの取扱ルール。
- タスク完了時に必ず提供すべき検証エビデンス。
読み取り専用タスクで指針の明確さを検証する
AGENTS.md を変更したら、すぐに大きなタスクに渡さない。Codex に読み取り専用モードで該当ルールの要約、実行予定のコマンド、承認が必要なアクションを計画させることで、曖昧さを迅速に洗い出せる。
検証するのは理解結果であり、モデルに隠されたシステムプロンプトや内部コンテキストの出力を求めてはいけない。モデルは自身の言葉でどのリポジトリ規約に従うかを説明するだけでよい。
codex -C /path/to/repo -s read-only "阅读适用于 frontend 模块的 AGENTS.md。概括允许修改的范围、必须运行的检查和需要先询问的操作;不要修改文件。"時代遅れのルールや重複ルールを継続的に整理する
ビルドシステム、ディレクトリ、リリースフローが変化したら AGENTS.md を同期的に更新する。重複ルールが多いほど、一方だけ更新されもう一方が古いまま残りやすくなる。
AGENTS.md を通常のコードレビューに組み込む。コマンドが実際に実行可能か、スコープが正確か、シークレットやマシン固有のパスが含まれていないかを確認し、重要なルール変更の理由を記録する。
- ドキュメント内のコマンドを定期的に実行する。
- ツールによって自動的に強制されるようになった冗長な記述を削除する。
- 専用のワークフローを Skill に移行する。
- 個人の好みとチームルールを分離する。
公式情報と検証範囲
本ガイドは公開されている公式ドキュメントを根拠にしています。コマンドや設定はクライアントのバージョンにより変わるため、実行前に参照元も確認してください。
技術検証方法を見る