Вклад в проект

Спасибо за ваш интерес к этому проекту! Прежде чем начать вносить свой вклад, пожалуйста, уделите немного времени, чтобы прочитать следующие рекомендации, чтобы ваш вклад мог быть легко принят.

Типы вкладов, которые не принимаются

1. Интернационализация/перевод документации
2. Вклад, связанный с основной инфраструктурой, такой как HTTP API и т. д.
3. Проблемы, явно помеченные как "No help needed" (включая проблемы в репозитории Byaidu/PDFMathTranslate).
4. Другие вклады, которые сопровождающие сочтут неуместными.
5. Вклад в документацию, но изменение документации на языках, отличных от английского.

Пожалуйста, НЕ отправляйте 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. Создайте PR на GitHub, предоставьте подробное описание и запросите ревью у @awwaawwa.
7. Убедитесь, что все автоматические проверки пройдены.

Основные требования

1. Рабочий процесс

• Пожалуйста, сделайте форк из ветки main и разрабатывайте на своей форкнутой ветке.
• При отправке 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 folder: Система конфигурации.
• translator folder: Реализации, связанные с переводчиком.
• gui.py: Предоставляет графический интерфейс.
• const.py: Некоторые константы.
• main.py: Предоставляет инструмент командной строки.
• high_level.py: Высокоуровневые интерфейсы на основе BabelDOC.
• http_api.py: Предоставляет HTTP API (не запущено).

Свяжитесь с нами

Если у вас есть какие-либо вопросы, отправьте отзыв через Issue или присоединяйтесь к нашей группе в Telegram. Спасибо за ваш вклад!