Voice-over-translation 贡献指南：如何参与开源项目开发

想要为 voice-over-translation 这个强大的视频翻译扩展贡献代码吗？🤝 这份完整指南将带你从零开始，掌握参与开源项目开发的终极技巧！voice-over-translation 是一个浏览器扩展，能够为视频添加多语言配音翻译功能，支持超过50种语言。

🚀 准备工作与开发环境搭建

克隆项目仓库

首先需要获取项目源代码：

git clone https://gitcode.com/gh_mirrors/vo/voice-over-translation
cd voice-over-translation

安装依赖环境

项目支持两种包管理器，你可以选择其中一种：

使用 Node.js：

npm install

使用 Bun：

bun install

voice-over-translation 使用 TypeScript 开发，所有新代码都应该使用 TypeScript 编写，避免提交 dist 文件夹中的文件。

📝 代码贡献流程详解

本地化翻译贡献

项目支持超过50种语言的本地化，所有翻译短语都必须添加到 localization.ts 文件中的 Phrase 和 Phrases 类型中。

推荐使用自动生成工具：

bun localize
# 或者
npm localize

新增网站支持

要为 voice-over-translation 添加新的视频网站支持，你需要在 vot.js 项目中做出必要的更改，然后将域名添加到 headers.json 的匹配列表中。

重要提醒： 不要忘记将新路径添加到 wiki data 中。这不会影响扩展的功能，但最好保持 wiki 的更新。

包更新与补丁管理

更新 @vot.js/... 包时：

npm install @vot.js/...

如果补丁损坏，需要按照特定流程修复，特别是在使用 Bun 时。

🔧 核心开发模块解析

音频下载器模块

• audioDownloader/strategies/ - 音频下载策略实现
• audioDownloader/shared.ts - 共享功能代码

翻译核心逻辑

• core/translationHandler.ts - 核心翻译处理
• core/videoManager.ts - 视频管理功能

用户界面组件

• ui/components/ - 完整的 UI 组件库
• ui/views/ - 视图层实现

🎯 最佳实践与代码规范

TypeScript 开发规范

• 所有新代码必须使用 TypeScript 编写
• 避免提交 dist 文件夹中的文件
• 遵循项目的代码风格和命名约定

补丁使用指南

重要： 不应该通过补丁来修改 vot.js 的主要逻辑和功能，例如通过补丁添加对新网站或新端点的支持。相反，应该在 vot.js 仓库 中进行更改。

补丁步骤：

1. 在 node_modules/@vot.js/<package_name>/dist/<file_name> 中进行更改
2. 使用以下命令保存更改：

npx patch-package @vot.js/<package_name>

📋 提交贡献清单

在提交贡献前，请确保：

• ✅ 代码使用 TypeScript 编写
• ✅ 本地化翻译已正确添加
• ✅ 新网站支持已完整配置
• ✅ 所有测试通过
• ✅ 文档已相应更新

💡 常见问题与解决方案

开发环境问题

• 确保使用 Node.js 22+ 或 Bun.sh
• 安装所有必要的依赖包
• 配置正确的 TypeScript 编译选项

构建与测试

项目提供了多种构建选项：

# 所有版本
npm run build

# 所有最小化版本
npm run build:min

# 仅普通版本
npm run build:default

# 仅普通最小化版本
npm run build:default-min

🌟 成为核心贡献者

voice-over-translation 项目欢迎各种类型的贡献：

• 代码改进和功能添加
• 新语言翻译支持
• 文档完善和错误修复
• 测试用例编写

通过遵循这份指南，你将能够顺利参与到 voice-over-translation 的开源开发中，为这个优秀的视频翻译项目贡献力量！🎉