Elevenlabs Text To Speech

🚀 開発ツール

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

📦 インストール

環境変数

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
   

✨ 主な機能

提示

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

• prompt_pr.md：詳細なプルリクエストの説明を生成するテンプレート
• prompt_commit.md：意味のあるコミットメッセージを作成するテンプレート
• prompt_user_story.md：GitHubのイシューとして適切な構造のユーザーストーリーを作成するテンプレート

スクリプト

scripts/ ディレクトリには、便利なスクリプトが含まれています：

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

💻 使用例

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

1. CursorのComposerで：

   • prompt_user_story.md を参照またはドラッグアンドドロップします
   • ユーザーストーリーで実現したい目標を説明します
   • AIが入力とコードベースを分析して、包括的なユーザーストーリーを生成します
   • 生成されたストーリーをレビューして確認します
   • AIが適切なプロジェクト割り当てでGitHubのイシューを作成するのを支援します

2. 生成されたユーザーストーリーには以下が含まれます：

   • プロダクトマネージャーの観点からのビジネス要件
   • 開発者の観点からの技術要件
   • ユーザーストーリーカードの基本情報
   • オプションの履歴部分
   • オプションの验收基準

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

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 で定義されたコードスタイルに従います
   • 必要に応じて設定説明を更新します

📚 詳細ドキュメント

ディレクトリ構造

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