Beitrag zum Projekt

Vielen Dank für Ihr Interesse an diesem Projekt! Bevor Sie mit Ihrem Beitrag beginnen, nehmen Sie sich bitte etwas Zeit, um die folgenden Richtlinien zu lesen, um sicherzustellen, dass Ihr Beitrag problemlos akzeptiert werden kann.

Arten von Beiträgen, die nicht akzeptiert werden

1. Dokumentationsinternationalisierung/-übersetzung
2. Beiträge im Zusammenhang mit der Kerninfrastruktur, wie z.B. HTTP-API, etc.
3. Probleme, die explizit als "Keine Hilfe benötigt" markiert sind (einschließlich Probleme im Byaidu/PDFMathTranslate Repository).
4. Andere Beiträge, die von den Maintainern als unangemessen erachtet werden.

Bitte reichen Sie KEINE PRs ein, die sich auf die oben genannten Arten beziehen.

Beitragsprozess

1. Forken Sie dieses Repository und klonen Sie es lokal.
2. Erstellen Sie einen neuen Branch: git checkout -b feature/<feature-name>.
3. Entwickeln Sie und stellen Sie sicher, dass Ihr Code den Anforderungen entspricht.
4. Committen Sie Ihren Code:

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

5. Pushen Sie zu Ihrem Repository: git push origin feature/<feature-name>.
6. Erstellen Sie einen PR auf GitHub, geben Sie eine detaillierte Beschreibung an und fordern Sie eine Überprüfung von @awwaawwa an.
7. Stellen Sie sicher, dass alle automatisierten Prüfungen bestanden werden.

Grundlegende Anforderungen

1. Arbeitsablauf

• Bitte forken Sie vom main-Branch und entwickeln Sie auf Ihrem geforkten Branch.
• Geben Sie beim Einreichen eines Pull Requests (PR) eine detaillierte Beschreibung Ihrer Änderungen an.
• Wenn Ihr PR die automatisierten Prüfungen nicht besteht (angezeigt durch checks failed und ein rotes Kreuz), überprüfen Sie bitte die entsprechenden details und passen Sie Ihre Einreichung an, um sicherzustellen, dass der neue PR alle Prüfungen besteht.

2. Entwicklung und Tests

• Verwenden Sie den Befehl pip install -e . für Entwicklung und Tests.

3. Code Formatting

• Konfigurieren Sie das pre-commit-Tool und aktivieren Sie black und flake8 für die Codeformatierung.

4. Abhängigkeitsaktualisierungen

• Wenn Sie neue Abhängigkeiten einführen, aktualisieren Sie bitte die Abhängigkeitsliste in der pyproject.toml-Datei zeitnah.

5. Dokumentationsaktualisierungen

• Wenn Sie neue Kommandozeilen-Optionen hinzufügen, aktualisieren Sie bitte die Liste der Kommandozeilen-Optionen in allen Sprachversionen der README.md-Datei entsprechend.

6. Commit-Nachrichten

• Verwenden Sie Conventional Commits, zum Beispiel: feat(translator): add openai.

7. Codierungsstil

• Stellen Sie sicher, dass Ihr eingereichter Code grundlegende Codierungsstilstandards einhält.
• Verwenden Sie entweder snake_case oder camelCase für die Benennung von Variablen.

8. Dokumentationsformatierung

• Für die Formatierung von README.md folgen Sie bitte den Chinesischen Richtlinien für Texterstellung.
• Stellen Sie sicher, dass sowohl die englische als auch die chinesische Dokumentation immer auf dem neuesten Stand sind; Aktualisierungen der Dokumentation in anderen Sprachen sind optional.

Hinzufügen einer Übersetzungsmaschine

1. Fügen Sie eine neue Übersetzerkonfigurationsklasse in der Datei pdf2zh/config/translate_engine_model.py hinzu.
2. Fügen Sie eine Instanz der neuen Übersetzerkonfigurationsklasse zum Typalias TRANSLATION_ENGINE_SETTING_TYPE in derselben Datei hinzu.
3. Fügen Sie die neue Übersetzerimplementierungsklasse im Ordner pdf2zh/translator/translator_impl hinzu.

Projektstruktur

• config folder: Konfigurationssystem.
• translator folder: Implementierungen im Zusammenhang mit Übersetzern.
• gui.py: Stellt die GUI-Schnittstelle bereit.
• const.py: Einige Konstanten.
• main.py: Stellt das Kommandozeilen-Tool bereit.
• high_level.py: Hochrangige Schnittstellen basierend auf BabelDOC.
• http_api.py: Stellt HTTP-API bereit (nicht gestartet).

Kontaktieren Sie uns

Wenn Sie Fragen haben, senden Sie bitte Feedback über Issue oder treten Sie unserer Telegram-Gruppe bei. Vielen Dank für Ihren Beitrag!