为项目做贡献

感谢您对本项目的关注！在开始贡献之前，请花些时间阅读以下指南，以确保您的贡献能够顺利被采纳。

不接受的贡献类型

1. 文档国际化/翻译
2. 与核心基础设施相关的贡献，例如 HTTP API 等
3. 明确标记为“无需帮助”的问题（包括 Byaidu/PDFMathTranslate 和 PDFMathTranslate/PDFMathTranslate-next 仓库中的问题）
4. 维护者认为不合适的其他贡献
5. 贡献文档，但修改非英语语言的文档
6. 需要修改 PDF 文件的 PR

请勿提交与上述类型相关的 PR。

贡献流程

1. Fork 此仓库并在本地克隆它。
2. 创建新分支：git checkout -b feature/<feature-name>。
3. 开发并确保代码符合要求。
4. 提交代码：

   git add .
   git commit -m "<semantic commit message>"
   

5. 推送至你的仓库：git push origin feature/<feature-name>。
6. 在 GitHub 上创建 PR，提供详细描述，并请求 @awwaawwa 进行审核。
7. 确保所有自动化检查通过。

基本要求

1. 工作流程

• 请从 main 分支进行 fork，并在你 fork 的分支上进行开发。
• 提交 Pull Request (PR) 时，请提供详细的变更说明。
• 如果你的 PR 未通过自动化检查（显示为 checks failed 并带有红色叉号），请查看对应的 details 并修改提交内容，确保新 PR 能通过所有检查。

2. 开发与测试

• 使用命令 pip install -e . 进行开发和测试。

3. 代码格式化

• 配置 pre-commit 工具并启用 black 和 flake8 进行代码格式化。

4. 依赖项更新

• 如果引入了新的依赖项，请及时更新 pyproject.toml 文件中的依赖列表。

5. 文档更新

• 如果添加了新的命令行选项，请在所有语言版本的 README.md 文件中相应更新命令行选项列表。

6. 提交信息

• 使用 约定式提交，例如：feat(translator): add openai。

7. 代码风格

• 确保提交的代码符合基本的编码风格标准。
• 变量命名请使用 snake_case 或 camelCase。

8. 文档格式

• 对于 README.md 的格式，请遵循中文文案排版指北。
• 确保英文和中文文档始终保持最新；其他语言文档的更新为可选。

添加翻译引擎

1. 在 pdf2zh/config/translate_engine_model.py 文件中添加一个新的翻译器配置类。
2. 在同一文件中将新的翻译器配置类实例添加到 TRANSLATION_ENGINE_SETTING_TYPE 类型别名中。
3. 在 pdf2zh/translator/translator_impl 文件夹中添加新的翻译器实现类。

项目结构

• config 文件夹：配置系统。
• translator 文件夹：翻译器相关实现。
• gui.py：提供 GUI 界面。
• const.py：一些常量。
• main.py：提供命令行工具。
• high_level.py：基于 BabelDOC 的高级接口。
• http_api.py：提供 HTTP API（未启动）。

联系我们

如有任何疑问，请通过 Issue 提交反馈或加入我们的 Telegram 群组。感谢您的贡献！