AGENTS.md/CLAUDE.md 日本語標準ファイル

AGENTS.md

リポジトリ運用ガイドライン

言語設定 (Language Configuration)

このプロジェクトは日本語環境での動作を前提とする。
基本的な受け答えは、全て日本語で行うこと。

• コミュニケーション: 日本語で対応
• コメント: コードコメントは日本語で記述
• ドキュメント: 技術文書は日本語で作成
• エラーメッセージ: 可能な限り日本語で表示
• 変数名・関数名: 英語を使用（国際的な慣例に従う）

プロジェクト状況

このプロジェクトでは、...

技術構成

• Node.js v22.14.0
• TypeScript v5.8

必要に応じて、ライブラリやフレームワークを追加。

機能要件

• ...

非機能要件

• ツールの利用方法のREADME.mdを用意する
• 再度やり直しても中間ファイルデータやデータベースの情報が壊れないようにする
• ツールのログは、全体のタスクを表示した上での進行状況をコンソールに出力する
• ログには、タイムスタンプを表示する
• GitHubで管理するための.gitignore
• .env などのクレデンシャルを含むファイルは.gitignoreに含め、GitHubなどに上らないようにする

プロジェクト構成とモジュール設計

• ソースコード: 機能単位で src/ に配置（例: src/api/, src/utils/）。
• テスト: tests/ でソース構造をミラー（例: tests/api/, tests/utils/）。
• スクリプト: CLI 用の補助タスクは scripts/（bash または言語別）。
• ドキュメント & アセット: 長文ノートは docs/、画像やスキーマは assets/。
• 設定: 環境変数のデフォルトは .env.example に置き、実際のシークレットはコミットしない。

ビルド・テスト・開発のコマンド

利用するフレームワークの標準的なスタイルに準拠する。

コーディングスタイルと命名規則

利用するフレームワークの標準的なスタイルに準拠する。 可能な限り、リンターやフォーマッターを導入し、ビルド時に自動化する。

テストガイドライン

ビジネスロジックが発生するもの、仕様に条件が加わるものは、ユニットテストを実装する。 利用するテスティングフレームワークの標準的なスタイルに準拠する。