FSMN VAD社区贡献指南：提交PR和issue的正确姿势
1. 贡献背景与价值
1.1 开源项目的重要性
FSMN VAD 是基于阿里达摩院 FunASR 框架开发的语音活动检测（Voice Activity Detection, VAD）模型，具备高精度、低延迟和轻量级等优势。该项目已被广泛应用于会议录音处理、电话分析、音频质量检测等多个实际场景。
随着社区用户的不断增长，越来越多开发者希望参与到项目的优化与功能扩展中。为了保障代码质量和协作效率，建立一套清晰、规范的贡献流程至关重要。
本指南旨在为所有希望参与 FSMN VAD 项目维护和改进的开发者提供标准化的操作指引，涵盖 issue 提交、PR 创建、代码风格要求以及审核流程等内容。
1.2 社区协作的核心原则
- 尊重开源精神：所有贡献均应以提升项目稳定性、可用性和可维护性为目标。
- 问题先行，实现跟进：建议在提交 Pull Request 前先通过 Issue 明确需求或 Bug。
- 文档同步更新：功能变更需同步修改相关说明文档，确保用户能及时获取最新信息。
- 保持沟通透明：鼓励在 PR 和 Issue 中积极讨论技术方案，避免闭门造车。
2. 如何正确提交 Issue
2.1 提交前的自查清单
在创建新的 Issue 之前，请务必完成以下检查：
- ✅ 是否已在 已有 Issues 中搜索过类似问题？
- ✅ 是否阅读了官方文档并确认是项目本身的缺陷而非使用不当？
- ✅ 是否能够复现该问题？是否准备了最小可复现示例？
若以上均为“是”，则可以继续提交 Issue。
2.2 Issue 分类与模板
根据问题性质，Issue 可分为三类，每类对应不同的标题前缀和内容结构：
| 类型 | 标题前缀 | 适用场景 |
|---|---|---|
| Bug 报告 | [BUG] | 功能异常、崩溃、结果错误等 |
| 功能请求 | [FEATURE] | 新增功能或模块建议 |
| 使用咨询 | [QUESTION] | 安装、配置、参数调优等问题 |
示例：Bug 报告模板
[BUG] 批量处理长音频时内存溢出 **环境信息** - Python 版本: 3.9.16 - FSMN VAD 版本: v1.2.0 - 操作系统: Ubuntu 20.04 - 硬件: CPU-only, 内存 8GB **问题描述** 当上传一个时长超过 30 分钟的 `.wav` 文件进行批量处理时，服务自动终止，终端输出 `MemoryError`。