贡献指南
感谢您对 Zotero PDF2zh 项目的关注！欢迎各种形式的贡献。
贡献类型
您可以通过以下方式参与项目：
- 报告 Bug
- 提出新功能建议
- 提交代码改进
- 完善文档
- 帮助其他用户解决问题
如何报告 Bug
提交 Issue 前，请先搜索是否已有相同问题。
Bug 报告模板
markdown
**问题描述**
简要描述遇到的问题
**环境信息**
- 操作系统：
- Zotero 版本：
- 插件版本：
- Python 版本：
- 翻译服务：
**重现步骤**
1.
2.
3.
**预期行为**
描述您期望发生的情况
**实际行为**
描述实际发生的情况
**日志信息**粘贴相关日志
**截图**
如有必要，请添加截图如何提交代码
开发环境设置
Fork 本仓库
克隆您的 Fork：
bash
git clone https://github.com/YOUR_USERNAME/zotero-pdf2zh.git
cd zotero-pdf2zh- 添加上游仓库：
bash
git remote add upstream https://github.com/guaguastandup/zotero-pdf2zh.git- 创建新分支：
bash
git checkout -b feature/your-feature-name代码规范
- 遵循项目现有代码风格
- 添加必要的注释
- 更新相关文档
- 确保代码通过测试
提交 Pull Request
- 推送您的分支：
bash
git push origin feature/your-feature-name在 GitHub 上创建 Pull Request
填写 PR 描述模板：
markdown
**更改类型**
- [ ] Bug 修复
- [ ] 新功能
- [ ] 代码重构
- [ ] 文档更新
**更改说明**
描述您的更改内容
**相关 Issue**
关闭 #issue_number文档贡献
文档位于 docs 目录，使用 VitePress 构建。
修改文档
- 编辑对应的 Markdown 文件
- 本地预览：
bash
cd docs
npm run docs:dev- 提交更改
社区行为准则
- 尊重不同观点和经验
- 使用友好和包容的语言
- 优雅地接受建设性批评
- 关注对社区最有利的事情
- 对其他社区成员表示同理心
获取帮助
TODO 列表
开发注意事项
以下功能正在规划中或已有实现方案，请勿自行开发，以免与项目规划冲突。
待办事项
| 状态 | 功能描述 | 备注 |
|---|---|---|
| ⏳ | HTML 翻译页面（包含候选项） | 功能规划中 |
| ⏳ | 服务添加对应的 thread_num 参数 | 性能优化 |
| ⏳ | README 增加 Command+, 快捷键说明 | 文档更新 |
| ⏳ | LLMEditor 的 URL 增加下拉选择框 | UI 改进 |
| ⏳ | 额外字段的设置问题 | 配置优化 |
| ⏳ | 基于 dual-cut 生成的文件保持原 service | 逻辑改进 |
已完成
| 状态 | 功能描述 |
|---|---|
| ✅ | Windows 终端显示表情问题 |
| ✅ | 自动更新 server.zip 的命令 |
| ✅ | 表格字段长度调整 |
暂不开发
| 状态 | 功能描述 | 原因 |
|---|---|---|
| ❌ | llmapi-table 双击条目弹出弹窗 | 暂不实现 |
建议
如果您有新功能建议，请先提交 Feature Request 讨论，避免重复开发。
活跃贡献者奖励
本项目与 沉浸式翻译 合作，为活跃贡献者提供每月 Pro 会员兑换码奖励。
致谢
感谢所有为本项目做出贡献的开发者！您的每一个 PR、Issue 和评论都让这个项目变得更好。