AGENTS.md

コーディング規約(共通)

コメント

• コメントには「なぜ(why)」を書く。「何をしているか(what)」はコードに書かない
• 既存のロジック説明コメントを勝手に削除しない

最小diff

• 修正対象のロジック以外を書き換えない
• バグ修正に周辺の掃除は不要
• 一回きりの操作にヘルパー関数を作らない

Python

• 型ヒント: 公開する関数には必須。list[str], X | None 構文を使う
• docstring: Google スタイル。公開する関数・クラスに必ず付ける
• import 順序: 標準ライブラリ → サードパーティ → プロジェクト内

コミット規約(共通)

• 形式: <type>: <要約>
• type: fix / feat / refactor / test / docs
• /ml-pipeline の実行中だけ <type>(step N): <要約> とし、N には .claude/plans/ の計画ファイルのステップ番号を入れる (例: fix(step 2): interpolation formulaの符号を修正)。 計画ファイルに紐づかない単独の作業では (step N) を付けない
• 1つの論理的変更ごとに1コミット
• git add は作業ディレクトリにパスを限定する

エージェント実行の共通契約(共通)

共通契約

• テストを追加したときは、修正前の実装で実行し FAIL することを確認してから実装する
• 仕様・外部から見える挙動・不可逆な選択について不明点があるときは、実装せず 質問を出力して終了する
• 保護パス(.claude/hooks/・settings.json 等)には触れない
• 完了の定義: 指示された変更のみを行い、検証コマンドが通ること

秘密情報の安全な取り扱い(共通)

• コマンドに生のAPIキー・トークン・パスワードを書かない
• 環境変数や .gitignore 対象の設定ファイルで管理する
• コード内にハードコードしない
• ログ、コミットメッセージ、PR説明文にも含めない