Jessica

🚀 開発ツール

このディレクトリには、プロジェクトで使用される様々な開発および生産性ツールが含まれています。これらのツールは、開発者やプロダクトマネージャーが一般的なタスクを完了し、コードベースの一貫性を維持するのを支援するために設計されています。

📚 ディレクトリ構造

.dev-tools/
├── prompts/           # 様々なタスクに使用するAIプロンプトテンプレート
│   ├── prompt_pr.md   # PR説明を生成するテンプレート
│   ├── prompt_commit.md # 意味のあるコミットメッセージを作成するテンプレート
│   └── prompt_user_story.md # GitHubの問題として構造的に良好なユーザーストーリーを作成するテンプレート
│
└── scripts/          # 開発用の実用スクリプト
    ├── generate_git_diffs.py  # git差分を生成するPythonスクリプト
    ├── check_env_files.py  # すべてのサービスの環境ファイルを検証するスクリプト
    ├── pyproject.toml       # Poetryプロジェクトの設定ファイル
    ├── .env.example        # 環境変数のサンプルファイル
    └── .env               # あなたのローカル環境変数（gitによって無視されます）

✨ ツールの概要

プロンプト

prompts/ディレクトリには、AIによるタスク支援用のテンプレートが含まれています。

• prompt_pr.md：詳細なPR説明を生成するテンプレート
• prompt_commit.md：意味のあるコミットメッセージを作成するテンプレート
• prompt_user_story.md：GitHubの問題として構造的に良好なユーザーストーリーを作成するテンプレート

スクリプト

scripts/ディレクトリには、実用的なスクリプトが含まれています。

• generate_git_diffs.py：ブランチ間のgit差分を生成し、コミット情報を収集するためのスクリプト
• check_env_files.py：すべてのサービスの環境ファイルを検証するスクリプト
  • .env.exampleテンプレートと比較して、欠落している.envファイルをチェックします。
  • すべての必須変数が設定されていることを確認します。
  • 置き換える必要のあるサンプル/プレースホルダー値を検出します。
  • .gitignoreパターンに一致することを検証します。
  • 明確な進捗インジケーターと要約レポートを提供します。

📦 インストール

環境変数

1. あなたのローカル環境ファイルを作成します。

   cd .dev-tools/scripts
   cp .env.example .env
   

2. .env内の変数を必要に応じて調整します。
   • GIT_DIFF_BRANCH：比較するブランチ（PRの場合はデフォルトでorigin/dev）
   • 注意：ほとんどのPRはdevブランチを対象とする必要があります。ホットフィックスまたはリリースPRの場合のみorigin/mainを使用してください。

Pythonの依存関係

1. まだインストールされていない場合は、Poetryをインストールします。

   curl -sSL https://install.python-poetry.org | python3 -
   

2. 依存関係をインストールします。

   cd .dev-tools/scripts
   poetry install
   

3. 仮想環境をアクティブ化します。

   poetry shell
   

💻 使用例

ワークフロー：AIを使用してユーザーストーリーを作成する

1. CursorのComposerで：
   • prompt_user_story.mdを参照またはドラッグアンドドロップします。
   • 実現したい目標を説明します。
   • AIがあなたの入力とコードベースを分析して、包括的なユーザーストーリーを生成します。
   • 生成されたストーリーを確認して承認します。
   • AIが適切なプロジェクト割り当てを持つGitHubの問題を作成するのを支援します。
2. 生成されたユーザーストーリーには以下が含まれます。
   • プロダクトマネージャーの観点からのビジネス要件
   • 開発者の観点からの技術要件
   • 明確な問題の説明と目標

ワークフロー：git差分を生成する

1. 差分を生成するためにスクリプトを実行します。

   cd .dev-tools/scripts
   poetry run python generate_git_diffs.py
   

2. スクリプトは以下を行います。
   • 比較する2つのブランチまたはコミットを選択します。
   • 詳細なファイルレベルの差分を表示します。
   • コピー&ペースト可能なgitコマンドを提供します。

ワークフロー：環境ファイルをチェックする

1. 環境チェッカーを実行します。

   cd .dev-tools/scripts
   poetry run python check_env_files.py
   

2. スクリプトは以下を行います。
   • プロジェクトをスキャンしてサービスディレクトリを検索します。
   • .gitignoreパターンを読み込んで尊重します。
   • 各サービスの環境設定をチェックします。
   • 以下を表示する詳細レポートを提供します。
     • ✅ 正しく設定された環境ファイル
     • ❌ 欠落している環境ファイル
     • ⚠️ サンプル値を使用している変数
     • ⚠️ サンプルファイルに含まれていない追加変数
3. レポートで指摘された問題を修正します。
   • .env.exampleテンプレートに基づいて、欠落している.envファイルを作成します。
   • 必要な変数を入力します。
   • サンプル/プレースホルダー値を実際の値に置き換えます。
   • 追加変数をレビューして、必要であることを確認します。

🔍 貢献ガイド

新しいツールを追加する際は、以下の手順に従ってください。

1. ツールの種類に応じて適切なサブディレクトリを作成します。
2. 明確なドキュメントを提供します。
3. このREADME内のツールの説明を更新します。
4. Pythonスクリプトの場合：
   • Poetryを使用して、pyproject.tomlに依存関係を追加します。
   • pyproject.tomlで定義されたコードスタイルに従います。
   • 必要に応じて、設定の説明を更新します。