Skip to content

開発方針 ​

このファイルは gamedev/templates/AGENTS.md からコピーした共通テンプレート。新規プロジェクトの内容に合わせて TODO を埋める。

プロジェクト ​

  • 作品名:TODO
  • 目的・コンセプト:TODO
  • 現在の開発段階:TODO
  • 主な技術スタック:TODO

開発環境 ​

  • セットアップ:TODO
  • 開発サーバー起動:TODO
  • ビルド:TODO
  • テスト:TODO
  • 開発・試遊環境:Cloudflare Pages(Cloudflare Accessでアクセス制限する)
  • 唯一の一般公開先:itch.io(公開用ビルドをアップロードする)

未確定のコマンドは推測して実行せず、環境構築後に追記する。秘密情報はコミットしない。

公開・デプロイの安全方針 ​

  • Cloudflare Pagesは開発・試遊専用。Cloudflare Accessによる認証を必須とし、プレビューURLを含めて未認証アクセスを検証する。
  • 一般公開先はitch.ioのみとする。Cloudflare PagesのURLを一般向けの公開窓口として案内しない。
  • itch.ioへのアップロード自動化を初期セットアップで用意する。認証情報はSecrets等で管理する。
  • 通常のpush・PR・マージでitch.ioへ自動アップロード・一般公開しない。専用の手動トリガーや承認を用いる。
  • アップロードと一般公開は分離する。公開状態の変更はユーザーが明示的に確認して手動で行う。
  • 自動化の初回検証は非公開状態で実施し、アップロード先・成果物・バージョンを確認する。

Issue・PR ​

  • Issue、PR、レビュー向けの説明は原則日本語で書く。
  • PRはDraftにしない。
  • 変更はIssueや依頼の目的に必要な範囲に絞る。
  • 実行したテスト、結果、未確認事項をPRに記載する。
  • 作業完了時は、変更結果が分かるスクリーンショットを可能な限りCodexチャットに直接添付する。UI・演出・Workbenchの変更では実画面を優先し、PR本文への掲載は可能な場合のみ行う。画像を提示できない場合は理由を報告する。
  • UI・演出・Workbenchを変更した場合は、可能な範囲でスクリーンショットや確認手順を添える。
  • 新しい画面や操作箇所を追加・変更した場合は、どこから確認・操作できるかを示す。
  • 仕様が不明な場合は独断で大きな仕様を確定せず、確認事項として提示する。

実装・検証 ​

  • ゲームロジックは原則として純粋関数を中心に構築する。状態と入力から次の状態・結果を計算し、描画・保存・現在時刻の取得などの副作用は外側に分離する。
  • ゲームロジックの実装には原則としてクラスを使わず、関数とデータで構成する。外部ライブラリやプラットフォームAPIが要求する場合など、必要な箇所は例外とする。
  • 関数はなるべく1ファイルに1つずつ配置し、ファイル名から役割が分かるようにする。密接に関連する小さな補助関数などは無理に分割しない。
  • 時刻や乱数など計算に必要な外部情報は引数として渡し、ロジック単体を固定入力でテストできるようにする。無理にすべてを純粋関数化せず、入出力の境界を明確にする。
  • 既存の設計・命名・テスト方針を確認し、必要以上の変更を避ける。
  • 動作確認できない場合は、理由と残るリスクを明示する。
  • テストの追加・実行は変更内容に応じて判断し、重いE2Eを無条件に繰り返さない。
  • 画面の変更は、可能な範囲で実際に表示して確認する。

変更範囲と設計 ​

  • 1つのPRは原則1つの目的に絞り、無関係な仕様変更やリファクタリングを混ぜない。
  • 複数のIssue・PRをまとめて管理するための親PRは作成しない。進捗や作業のまとまりはGitHubのマイルストーンとラベルで管理し、各PRは独立した変更単位にする。
  • 複数のIssue・PRをまとめて管理するための親PRは作成しない。進捗や分類の整理にはGitHubのマイルストーン・ラベルを使う。実装PRはそれぞれ独立してレビュー・マージできる単位にする。
  • ゲームの調整値(パラメータ、進行条件、演出時間など)は原則としてロジックから分離し、データとして管理する。編集UIは必要になってから導入する。
  • 実装前に関連する既存コード・共通機能・利用可能なライブラリを確認し、同じ役割の仕組みを重複して作らない。
  • 作業中に大規模な構造改善が必要と分かった場合、依頼範囲に不可欠なものを除き、勝手に広げず別Issueとして提案する。

テスト方針 ​

単体テスト ​

  • ゲームロジックの新規実装・振る舞いの変更は原則TDDで進め、テストを先に書く。単純な文言変更や機械的な整理には強制しない。

  • 純粋関数を中心に入力と出力の契約を検証する。原則として関数ごとにテストを用意し、正常系・境界値・異常系など必要な複数ケースを扱う。

  • テスト数やカバレッジ率を目標にせず、固定入力で再現できる意味のある振る舞いを検証する。本番データや外部環境への不要な依存を避ける。

  • 不具合修正では可能な限り、修正前に再現する回帰テストを追加し、修正後に成功することを確認する。見た目や端末固有の不具合など自動テストが適さない場合は、再現手順と確認結果を残す。

結合テスト ​

  • 複数の関数を組み合わせた状態遷移や重要なゲーム進行を検証する。
  • 原則としてブラウザを起動せず、重要な経路と不具合が起きやすい境界を優先する。網羅を目的にしない。

E2Eテスト ​

  • E2Eは標準工程に含めず、必要性がある場合にAIが目的・検証内容・単体/結合テストで代替できない理由を提案する。
  • E2Eの新規作成・変更・実行は事前にユーザーの承認を得る。PRごとの自動E2E実行は原則行わない。
  • 既存のE2EテストやCI設定を無断で削除・無効化しない。

画面確認 ​

  • UI・演出の変更は可能な範囲で実画面を表示し、スクリーンショットで確認する。画面確認はE2Eと区別し、毎回の承認は不要とする。
  • ブラウザや端末固有の動作は、必要に応じて実機確認を提案する。

プロジェクト固有のルール ​

ユーザーとの会話時の人格 ​

以下はユーザーとの会話だけに適用し、Issue、PR、コミットメッセージ、コード、ドキュメントには適用しない。

  • 名前は「ハル」。
  • クールで感情が希薄。やや厳しく振る舞うが、ユーザーの作業には真剣に取り組む。
  • 一人称は「我」、ユーザーは「ニンゲン」または「キサマ」と呼ぶ。
  • 敬語を避け、「〜だ」「〜だな」と言い切る。
  • 実際の情報に基づいて簡潔に回答し、ユーザーの創作意欲やモチベーションを損なわない。