参与 Fast-VC 开发
1. 从这里开始
欢迎提交修复、文档改进、可复现的问题报告和服务集成。先阅读项目主页和文档索引。项目文档以中文维护,项目介绍、安装、配置、API 和故障排查提供英文译文;设计、任务记录和每日工程日志以中文维护。
问题和建议通过 GitHub Issues 提交。请说明仓库版本或提交、模型与配置、环境、输入格式、复现步骤、预期行为和实际结果,提供最小示例及脱敏日志。
2. 准备开发环境
克隆时包含子模块,按快速开始准备环境。使用 uv 和仓库现有的 pyproject.toml、uv.lock,在仓库根目录执行命令。
服务代码位于 src/fast_vc_service/,客户端位于 examples/websocket/,配置位于 configs/。Seed-VC 子模块属于本仓库的依赖,修改流式处理行为前先阅读当前设计。
3. 提出与实现改动
重要功能、协议变更、重构、推理行为或部署变更,先在 Spec 中记录设计和验收标准,再开始实现。小修复可以只写简短的 changelog;续做同一任务时更新已有记录。
一次改动围绕同一目的。行为变化时同步当前设计及相关用户文档,已纳入翻译范围的文档同步更新中英文版本。文档维护约定统一说明原文语言、翻译范围和导航规则,新增文档不自动要求翻译。AI 辅助开发遵循 AGENTS.md。
4. 验证
文档改动检查相对链接、锚点、源码一致性和 git diff --check。
文档网站可独立预览,无需安装服务和模型依赖:
npm --prefix docs/website ci --ignore-scripts
npm --prefix docs/website run dev预览使用 Node.js 24;网站工程集中在 docs/website,正文在 docs/zh 和 docs/en 的 Markdown 中维护。提交前执行 Python 内容检查、检查器与网站适配回归用例、生产构建和网页检查,完整命令及 Pages 发布流程见文档网站。内容检查可用 --base origin/main 提醒源码改动影响的文档及单侧译文变化;提醒需要人工审查,不能证明语义同步。
代码改动按影响范围选择协议或配置检查、服务联调、GPU 推理、试听评测或压力测试。服务目前没有专门的自动化回归套件,文档检查器的测试和客户端示例不代表服务回归覆盖;说明实际执行了哪些验证,以及哪些仍未测试。
性能和音质结果需要注明模型、硬件、配置及输入条件,方法见评测指南。除非贡献范围已明确包含相关内容的公开发布,否则不要将原始音频、模型缓存、会话输出或凭据加入改动。
5. 拉取请求与提交
说明问题、改动后的行为、兼容影响和验证结果,链接相关 Issue 或 Spec,并写明限制。保留无关修改及历史记录。
提交信息使用 <类型>: <中文描述>,例如 docs: 更新流式接口与快速开始。类型包括 feat、fix、docs、refactor、test、build、ci、chore。