Skip to content

Latest commit

 

History

History
81 lines (60 loc) · 1.75 KB

File metadata and controls

81 lines (60 loc) · 1.75 KB

Whisper App 贡献指南

欢迎为 Whisper App 项目做出贡献!本指南将帮助您了解如何参与项目开发。

🤝 如何贡献

贡献方式

  • 报告问题: 发现Bug或提出改进建议
  • 提交代码: 修复问题或添加新功能
  • 改进文档: 完善项目文档
  • 分享经验: 在社区分享使用经验

开始贡献

  1. Fork项目: 点击GitHub页面的Fork按钮
  2. 克隆代码: git clone <your-fork-url>
  3. 创建分支: git checkout -b feature/your-feature
  4. 开发功能: 按照开发环境搭建指南配置环境
  5. 提交PR: 创建Pull Request

📝 代码规范

提交消息格式

<type>(<scope>): <description>

feat(api): add batch upload functionality
fix(ui): resolve audio player issue
docs(readme): update installation guide

代码风格

  • 使用TypeScript
  • 遵循ESLint规则
  • 使用Prettier格式化
  • 添加适当的注释

🐛 问题报告

报告Bug

  1. 搜索现有Issues确认问题未被报告
  2. 使用Bug报告模板
  3. 提供详细的重现步骤
  4. 包含系统信息和日志

功能请求

  1. 详细描述功能需求
  2. 说明使用场景
  3. 提供可能的实现方案

📚 文档贡献

  • 修正错误或不准确信息
  • 添加缺失的使用示例
  • 翻译文档到其他语言
  • 改进文档结构和可读性

🎯 开发优先级

高优先级

  • Bug修复
  • 安全问题
  • 性能优化
  • 核心功能改进

中优先级

  • 新功能开发
  • UI/UX改进
  • 文档完善

低优先级

  • 代码重构
  • 实验性功能

📞 获取帮助

  • GitHub Issues: 技术问题和Bug报告
  • Discussions: 功能讨论和经验分享
  • 文档: 查看完整的项目文档

感谢您的贡献!🙏