Skip to content

Latest commit

 

History

History
63 lines (42 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

63 lines (42 loc) · 1.41 KB

贡献指南

感谢你对本项目的关注！我们欢迎各种形式的贡献。

🚀 如何贡献

报告问题

如果发现了 bug 或有功能建议，请：

  1. 检查 Issues 中是否已有相关问题
  2. 如果没有，请创建新的 Issue，包含：
    • 清晰的问题描述
    • 复现步骤
    • 预期行为 vs 实际行为
    • 环境信息（Python 版本、操作系统等）

提交代码

  1. Fork 本仓库
  2. 创建功能分支 (git checkout -b feature/AmazingFeature)
  3. 提交更改 (git commit -m 'Add some AmazingFeature')
  4. 推送到分支 (git push origin feature/AmazingFeature)
  5. 开启 Pull Request

代码规范

  • 遵循 PEP 8 Python 代码风格
  • 添加适当的注释和文档字符串
  • 确保代码通过基本的语法检查

📝 开发环境设置

# 克隆仓库
git clone https://github.com/your-username/fast-whisper-api.git
cd fast-whisper-api

# 创建虚拟环境
python3 -m venv venv
source venv/bin/activate  # Windows: venv\Scripts\activate

# 安装依赖
pip install -r requirements.txt

# 运行服务
uvicorn main:app --reload

🧪 测试

在提交 PR 之前，请确保：

  • 代码可以正常导入
  • 服务可以正常启动
  • API 端点可以正常响应

📚 文档

如果修改了 API 或添加了新功能，请更新相应的文档。

感谢你的贡献！🎉