Beitrag zum Projekt

Caution

Die aktuellen Projektbetreuer erforschen die automatisierte Internationalisierung der Dokumentation. Daher werden keine PRs im Zusammenhang mit der Internationalisierung/Übersetzung der Dokumentation akzeptiert!

Bitte reichen Sie KEINE PRs im Zusammenhang mit der Internationalisierung/Übersetzung der Dokumentation ein!

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, damit Ihr Beitrag problemlos akzeptiert werden kann.

Nicht akzeptierte Beitragsarten

Dokumentationsinternationalisierung/-übersetzung
Beiträge zur Kerninfrastruktur, wie z. B. HTTP-API usw.
Probleme, die explizit als "Keine Hilfe benötigt" markiert sind (einschließlich Probleme in den Repositorys Byaidu/PDFMathTranslate und PDFMathTranslate/PDFMathTranslate-next).
Andere Beiträge, die von den Maintainern als unangemessen erachtet werden.
Beiträge zur Dokumentation, aber Änderungen an der Dokumentation in anderen Sprachen als Englisch.
PRs, die Änderungen an PDF-Dateien erfordern.
PRs, die die Datei pdf2zh_next/gui_translation.yaml modifizieren.

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

Note

Wenn Sie zur Dokumentation beitragen möchten, ändern Sie bitte nur die englische Version der Dokumentation. Andere Sprachversionen werden von den Mitwirkenden selbst übersetzt.

Beitragsprozess

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

Committen Sie Ihren Code:

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

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

Tip

Sie müssen nicht warten, bis Ihre Entwicklung vollständig abgeschlossen ist, um einen PR zu erstellen. Eine frühzeitige Erstellung ermöglicht es uns, Ihre Implementierung zu überprüfen und Vorschläge zu machen.

Wenn Sie Fragen zum Quellcode oder verwandten Themen haben, wenden Sie sich bitte an den Maintainer unter [email protected].

Ressourcendateien für Version 2.0 werden mit BabelDOC geteilt. Der Code zum Herunterladen der relevanten Ressourcen befindet sich in BabelDOC. Wenn Sie neue Ressourcendateien hinzufügen möchten, wenden Sie sich bitte an den BabelDOC-Maintainer unter [email protected].

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 Test

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

3. Code-Formatierung

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 Kommandozeilenoptionen hinzufügen, aktualisieren Sie bitte die Liste der Kommandozeilenoptionen 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 Copywriting-Richtlinien.
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

Fügen Sie eine neue Übersetzer-Konfigurationsklasse in der Datei pdf2zh/config/translate_engine_model.py hinzu.
Fügen Sie eine Instanz der neuen Übersetzer-Konfigurationsklasse zum Typalias TRANSLATION_ENGINE_SETTING_TYPE in derselben Datei hinzu.
Fügen Sie die neue Übersetzer-Implementierungsklasse im Ordner pdf2zh/translator/translator_impl hinzu.

Note

Dieses Projekt beabsichtigt nicht, Übersetzungsmaschinen mit einer RPS (Anfragen pro Sekunde) von weniger als 4 zu unterstützen. Bitte reichen Sie keine Unterstützung für solche Maschinen ein. Die folgenden Arten von Übersetzern werden ebenfalls nicht integriert: - Übersetzer, die von den ursprünglichen Maintainern eingestellt wurden (wie deeplx) - Übersetzer mit großen Abhängigkeiten (wie solche, die von pytorch abhängen) - Instabile Übersetzer - Übersetzer, die auf Reverse-Engineering-APIs basieren

Wenn Sie unsicher sind, ob ein Übersetzer die Anforderungen erfüllt, können Sie ein Issue erstellen, um mit den Maintainern zu diskutieren.

Projektstruktur

config folder: Konfigurationssystem.
translator folder: Übersetzerbezogene Implementierungen.
gui.py: Bietet die GUI-Schnittstelle.
const.py: Einige Konstanten.
main.py: Bietet das Kommandozeilen-Tool.
high_level.py: Hochrangige Schnittstellen basierend auf BabelDOC.
http_api.py: Bietet HTTP API (nicht gestartet).

Kontaktieren Sie uns

Wenn Sie Fragen haben, können Sie Feedback über Issue einreichen oder unserer Telegram-Gruppe beitreten. Vielen Dank für Ihren Beitrag!

Tip

Immersive Translate sponsert monatliche Pro-Mitgliedschaftscodes für aktive Mitwirkende an diesem Projekt. Einzelheiten finden Sie unter: BabelDOC/PDFMathTranslate Beitragsbelohnungsregeln