Elevenlabs Text To Speech

🚀 開發工具

本項目中的 .dev-tools 目錄收納了各類開發與生產力工具，旨在助力開發者和產品經理高效完成常見任務，同時確保代碼庫的一致性。

🚀 快速開始

環境變量

1. 創建本地環境文件：

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

2. 根據需要調整 .env 中的變量：

   • GIT_DIFF_BRANCH：要比較的分支（默認為 origin/dev 用於 PR）
   • 注意：大多數 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 模式
  • 提供清晰的進度指示器和總結報告

📦 安裝指南

環境變量

1. 創建您的本地環境文件：

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

2. 根據需要調整 .env 中的變量：

   • GIT_DIFF_BRANCH：要比較的分支（默認為 origin/dev 用於 PR）
   • 注意：大多數 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. 生成的用戶故事將包括：

   • 從產品經理角度的業務需求
   • 從開發者角度的技術需求
   • 用戶故事卡片的基本信息
   • 可選的歷史記錄部分
   • 可選的驗收標準

工作流：檢查環境文件

1. 運行環境檢查器：

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

2. 腳本將執行以下操作：

   • 掃描項目以查找服務目錄
   • 加載並尊重 .gitignore 模式
   • 檢查每個服務的環境配置
   • 提供詳細報告，顯示：
     • ✅ 正確配置的環境文件
     • ❌ 缺少的環境文件
     • ⚠️ 使用示例值的變量
     • ⚠️ 額外的變量不在示例文件中

3. 修復報告中指出的問題：

   • 根據 .env.example 模板創建缺失的 .env 文件
   • 填充必需變量
   • 替換示例/佔位符值為實際值
   • 審查額外變量以確保其必要性

📚 詳細文檔

目錄結構

.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忽略）

工具概述

提示

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 模式
  • 提供清晰的進度指示器和總結報告

設置

環境變量

1. 創建您的本地環境文件：

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

2. 根據需要調整 .env 中的變量：

   • GIT_DIFF_BRANCH：要比較的分支（默認為 origin/dev 用於 PR）
   • 注意：大多數 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. 生成的用戶故事將包括：

   • 從產品經理角度的業務需求
   • 從開發者角度的技術需求
   • 用戶故事卡片的基本信息
   • 可選的歷史記錄部分
   • 可選的驗收標準

工作流：檢查環境文件

1. 運行環境檢查器：

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

2. 腳本將執行以下操作：

   • 掃描項目以查找服務目錄
   • 加載並尊重 .gitignore 模式
   • 檢查每個服務的環境配置
   • 提供詳細報告，顯示：
     • ✅ 正確配置的環境文件
     • ❌ 缺少的環境文件
     • ⚠️ 使用示例值的變量
     • ⚠️ 額外的變量不在示例文件中

3. 修復報告中指出的問題：

   • 根據 .env.example 模板創建缺失的 .env 文件
   • 填充必需變量
   • 替換示例/佔位符值為實際值
   • 審查額外變量以確保其必要性

🔧 貢獻

添加新工具時：

1. 根據工具類型創建適當的子目錄
2. 包括清晰的文檔
3. 更新此 README 中的新工具描述
4. 對於 Python 腳本：
   • 將依賴項添加到 pyproject.toml 中，使用 Poetry
   • 遵循 pyproject.toml 定義的代碼風格
   • 如果需要更新設置說明