為專案貢獻

感謝您對本專案的關注！在開始貢獻之前，請花些時間閱讀以下指南，以確保您的貢獻能夠順利被接受。

不接受的貢獻類型

1. 文檔國際化/翻譯
2. 與核心基礎設施相關的貢獻，例如 HTTP API 等
3. 明確標記為「No help needed」的議題（包括 Byaidu/PDFMathTranslate 和 PDFMathTranslate/PDFMathTranslate-next 存儲庫中的議題）
4. 維護者認為不適當的其他貢獻
5. 貢獻文檔，但修改非英文的其他語言文檔
6. 需要修改 PDF 文件的 PR
7. 修改 pdf2zh_next/gui_translation.yaml 文件的 PR

請勿提交與上述類型相關的 PR。

貢獻流程

1. 複製此儲存庫並在本地克隆。
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. 提交訊息

• 使用 Conventional Commits，例如：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 群組。感謝您的貢獻！