AGENTS.mdに毎回の指示をまとめる
AGENTS.mdには、そのプロジェクトで毎回守ってほしい作業上の約束を書きます。起動方法や確認コマンドもここにまとめられます。
1. 置き場所を決める
プロジェクト全体の指示はのルートに置きます。下位フォルダ固有の指示は、そのフォルダに分けられます。
2. 必要な約束を書く
目的、起動方法、テスト方法、編集範囲、納品方法を短く書きます。
3. 読み込みを確認する
新しいセッションで、読み込んだ指示と適用範囲を確認します。下位の指示が上位を上書きする場合があります。
~/manual-demo $ codex exec "このリポジトリの AGENTS.md を作って。既存のコードから実際に守られている書き方を読み取って書いて。守られていない理想論は書かないで。"AGENTS.md を作成しました。（抜粋） ## 既存コードに合わせる書き方 - JavaScript の CommonJS を使う。関数はトップレベルの function 宣言で定義し、 ファイル末尾の module.exports = { ... }; で公開する。- インデントはスペース2個。文末にセミコロンを付ける。- 関数名・引数名は reduceStock、itemId のような camelCase に合わせる。- 関数の説明は直前の短い日本語の // コメントで書く。未実装事項には // TODO: が使われている。 ## 実行・検証に関する事実 - README には npm install の後に npm start とあるが、現時点では package.json も ロックファイルも存在せず、この手順を裏付ける設定はない。- テストファイル、テストランナー、lint・フォーマッターの設定、CI 設定は存在しない。 未定義のコマンドを既存の開発手順として案内しない。
コピーして使える依頼文
このプロジェクト用のAGENTS.mdを作って。目的、実際に使える起動・テストコマンド、編集範囲、完了時の報告項目を、現在のファイルを確認して短くまとめて。
この依頼文だと、こう返ってきます
現在のファイルを確認して作りました。実際に動くコマンドだけ載せています。
――――――
# AGENTS.md
## このプロジェクト
社内向けの在庫管理Webアプリ。Node.js + PostgreSQL。
## 起動とテスト
- 開発: npm run dev（http://localhost:3000）
- テスト: npm test
- 1ファイルだけ: npm test -- tests/<名前>.test.js
- 型チェック: npm run typecheck
## 編集範囲
- 変更してよい: src/, tests/
- 触らない: migrations/（DBの履歴。変更は別途相談）
- 生成物: dist/（直接編集しない）
## 完了時に報告すること
- 変更したファイルの一覧
- 実行したテストとその結果
- 手で確認が必要な箇所
――――――
npm run typecheck は package.json にあることを確認済みです。READMEにあった npm start は、対応するスクリプトが無かったため入れていません。
実際の返答はそのときの資料や状況で変わります。形の目安として載せています。
完成チェック
- 実在するコマンドが書かれている
- 新しいセッションで読み込まれる