Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
133 lines (95 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

133 lines (95 loc) · 2.71 KB
Raw

🤝 贡献指南

感谢你对 Flash Transcribe 项目的关注！我们欢迎任何形式的贡献。

📝 如何贡献

🐛 报告 Bug

如果你发现了 Bug，请：

  1. 在 Issues 中搜索是否已有相关问题
  2. 如果没有，创建新 Issue 并提供：
    • 详细的问题描述
    • 复现步骤
    • 期望行为 vs 实际行为
    • 环境信息（操作系统、Python 版本等）
    • 错误日志（如果有）

✨ 提出新功能

如果你有好的想法：

  1. 在 Issues 中描述你的功能建议
  2. 说明为什么需要这个功能
  3. 如果可能，提供实现思路

🔧 提交代码

  1. Fork 项目

    # 点击右上角 Fork 按钮

  2. 克隆到本地

    git clone https://github.com/YOUR_USERNAME/flash-transcribe.git
cd flash-transcribe

  3. 创建分支

    git checkout -b feature/your-feature-name
# 或
git checkout -b fix/your-bug-fix

  4. 进行修改

    • 保持代码风格一致
    • 添加必要的注释
    • 确保代码能正常运行

  5. 提交更改

    git add .
git commit -m "描述你的更改"

  6. 推送到 GitHub

    git push origin feature/your-feature-name

  7. 创建 Pull Request

    • 在 GitHub 上打开你的 Fork
    • 点击 "New Pull Request"
    • 填写详细的 PR 描述

📐 代码规范

Python 代码

  • 遵循 PEP 8 风格指南
  • 使用有意义的变量名和函数名
  • 添加必要的类型注释（Type Hints）
  • 编写清晰的文档字符串

提交信息

使用清晰的提交信息：

类型: 简短描述（不超过 50 字符）

详细说明（如果需要）

- 解决了什么问题
- 如何解决的
- 影响范围

类型标签：

  • feat: 新功能
  • fix: Bug 修复
  • docs: 文档更新
  • style: 代码格式调整
  • refactor: 代码重构
  • test: 测试相关
  • chore: 构建/工具相关

示例

feat: 添加自动语言检测功能

实现了基于文件名的语言自动检测：
- 支持 zh/en 文件名后缀识别
- 自动设置 Whisper 语言参数
- 向后兼容现有配置

🧪 测试

在提交 PR 前，请确保：

  • 代码能在 Windows 10/11 上正常运行
  • 没有引入新的依赖（或在 PR 中说明）
  • 更新了相关文档（如果需要）
  • 测试了基础转录和 AI 增强两种模式

📞 联系方式

如有疑问，欢迎通过以下方式联系：

💖 感谢

感谢所有贡献者的付出！每一个贡献都让这个项目变得更好。

Happy Coding! 🚀