AGENTS.md (Codex)

AGENTS.md

<instructions>
  <important>
    明示的に作成不要の指示がない限り、ADRを作成せずに実装作業を開始してはならない。
  </important>

  <workflow>
    1. アーキテクト(ユーザー)が指示を出す  
    2. アシスタントは、情報や状況・実装方法を調査し、ADRを作成する。
    3. アシスタントは、作成したADRをサブエージェントによりレビューし、レビュー結果を検討の上、修正する。
    4. アーキテクト(ユーザー)が承認すると、アシスタントは実装を開始する。
    5. アシスタントは、実装完了後、作成したコード差分をサブエージェントによりレビューし、レビュー結果を検討の上、修正する。
    6. アーキテクト(ユーザー)が検収する。

    ※工程途中で問題が発生した場合は、差し戻しを行う。
  </workflow>

  <workflow_rule>
    - コードベース全体を確認し、設計および修正方針の妥当性を確認してから作業すること。
    - コード実装・コード編集を開始する前に、`adr` サブフォルダ内へMarkdown形式のADR（Architecture Decision Record）を作成すること。
    - ADR作成中にわかった、独自の設計思想や注意点については、`adr` サブフォルダ内へfindings.mdを作成し、そこに記録すること。
    - ADRについてアーキテクト（ユーザー）の承認を得てから、コード実装・コード編集を開始すること。
    - 明示的に「承認」または「実装開始」と指示されるまで、ADRは未承認として扱うこと。この状態をユーザーへ説明する必要はない。
    - 承認済みADRから設計または実現方法を変更する場合、新しいADRを作成し、再度承認を得ること。
    - 前提条件が根本的に変化した場合、またはADRと競合する課題を発見した場合、作業を中止して再検討に必要な質問を行うこと。
  </workflow_rule>

  <adr>
    - ADRは構造化し、簡潔かつ必要十分な内容とすること。
    - 冗長な記述や重複記述を含めないこと。
    - 採用されなかったADRはステータスを「不採用」に変更すること。
  </adr>

  <implementation_principles>
    - 未リリースのプロトタイプとして扱うこと。明示的な指示がある場合は、その指示を優先すること。
    - 機能追加では簡素さを重視し、必要に応じて互換性を破壊すること。
    - 過剰な実装、過剰なセキュリティ対策、過剰な互換性対応を追加しないこと。
    - 修正内容が要求を十分に満たしているか確認すること。
    - 目的に対して実装規模・抽象化・汎用化・防御的処理が過剰になっていないか確認すること。
    - 移行措置または互換性維持のためのコードを追加する場合、後から削除可能な範囲が分かるよう注釈コメントで囲むこと。
    - 一般的ではない実装や記述を採用する箇所には、そのコードが必要な理由を `why` として記載すること。
  </implementation_principles>

  <runtime_assumptions>
    - 明示的な指示がない限り、LAN/VPN内、自家使用、家庭内での運用を前提とすること。
    - Public Internet向けのセキュリティ基準を自動的に適用しないこと。
    - サーバープロセスは1プロセスでの動作を基本とすること。
    - 要求やコードベース上の根拠がない限り、複数プロセスの同時実行などの特殊な実行条件を仮定しないこと。
  </runtime_assumptions>

  <review>
    - コードおよびADRを修正した後、サブエージェントを使用して同様のレビューを行うこと。
    - レビュー指摘がある場合、その指摘が妥当か、本質的か、要求や設計方針に適合するかを評価してから再修正すること。
    - 特に低優先度の指摘は、本質的な問題かどうかを慎重に評価すること。
  </review>

  <testing>
    - テスト中に、テスト手法またはテスト手順に起因する不良・問題が発生した場合、再発防止策を `TESTING.md` に記録すること。
    - `TESTING.md` には再発防止策に必要な情報だけを記載すること。
  </testing>

  <file_io>
    - すべてのファイル入出力でUTF-8を明示的に指定すること。
    - PowerShellでは既定の文字コードを信用せず、読み書きの双方でUTF-8を明示すること。
  </file_io>

  <command_execution>
    - 3ステートメントを超える長大なコマンドを実行する場合、実行前にその内容と目的を説明すること。
  </command_execution>

  <cleanup>
    - 生成キャッシュなど、残存しても害のないファイルまで積極的にクリーンアップする必要はない。
  </cleanup>
</instructions>