Contribuer au projet

Merci pour votre intérêt pour ce projet ! Avant de commencer à contribuer, veuillez prendre le temps de lire les directives suivantes pour vous assurer que votre contribution puisse être acceptée sans problème.

Types de contributions non acceptées

1. Documentation internationalisation/traduction
2. Contributions liées à l'infrastructure principale, telles que l'API HTTP, etc.
3. Problèmes explicitement marqués comme "No help needed" (y compris les problèmes dans les dépôts Byaidu/PDFMathTranslate et PDFMathTranslate-next/PDFMathTranslate-next).
4. Autres contributions jugées inappropriées par les mainteneurs.
5. Contribution à la documentation, mais modification de la documentation dans des langues autres que l'anglais.
6. PRs nécessitant la modification de fichiers PDF.
7. PRs modifiant le fichier pdf2zh_next/gui_translation.yaml.

Veuillez ne PAS soumettre de PR liées aux types mentionnés ci-dessus.

1. UI/UX changes

• Major UI/UX changes (e.g., redesigning the entire interface or adding significant new features)
• Changes to existing workflows that could affect user experience
• Addition of new dependencies for UI components

2. Core functionality modifications

• Changes to the core translation engine or algorithms
• Modifications to file handling or processing logic
• Performance optimizations that alter existing behavior

3. Architectural changes

• Refactoring large portions of the codebase
• Changing the project structure or build system
• Database schema changes or migrations

4. New feature proposals

• Significant new features that would expand the project's scope
• Integration with external services or APIs
• Authentication/authorization systems

5. Breaking changes

• Any changes that break backward compatibility
• Deprecation of existing features
• Changes to public APIs or interfaces

6. Security-related changes

• Security patches or vulnerability fixes
• Authentication/authorization improvements
• Data privacy enhancements

7. Documentation updates

• Major rewrites of documentation
• Translation of documentation into new languages
• Structural changes to documentation

TRANSLATION RESULT

PR qu'il est recommandé de discuter avec les mainteneurs via une Issue avant la soumission

1. Modifications de l'interface utilisateur / de l'expérience utilisateur

• Modifications majeures de l'interface utilisateur / de l'expérience utilisateur (par exemple, refonte de l'interface entière ou ajout de fonctionnalités nouvelles importantes)
• Modifications des workflows existants qui pourraient affecter l'expérience utilisateur
• Ajout de nouvelles dépendances pour les composants de l'interface utilisateur

2. Modifications des fonctionnalités principales

• Modifications du moteur de traduction principal ou des algorithmes
• Modifications de la gestion des fichiers ou de la logique de traitement
• Optimisations des performances qui modifient le comportement existant

3. Modifications architecturales

• Refactorisation de grandes parties de la base de code
• Modification de la structure du projet ou du système de build
• Modifications du schéma de base de données ou des migrations

4. Propositions de nouvelles fonctionnalités

• Nouvelles fonctionnalités importantes qui étendraient la portée du projet
• Intégration avec des services externes ou des API
• Systèmes d'authentification / d'autorisation

5. Changements cassants

• Toute modification qui brise la rétrocompatibilité
• Dépréciation de fonctionnalités existantes
• Modifications des API publiques ou des interfaces

6. Modifications liées à la sécurité

• Correctifs de sécurité ou corrections de vulnérabilités
• Améliorations de l'authentification / de l'autorisation
• Améliorations de la confidentialité des données

7. Mises à jour de la documentation

• Réécritures majeures de la documentation
• Traduction de la documentation dans de nouvelles langues
• Modifications structurelles de la documentation

1. UI/UX changes

• Major UI/UX changes (e.g., redesigning the entire interface or adding significant new features)
• Changes to existing workflows that could affect user experience
• Addition of new dependencies for UI components

2. Core functionality modifications

• Changes to the core translation engine or algorithms
• Modifications to file handling or processing logic
• Performance optimizations that alter existing behavior

3. Architectural changes

• Refactoring large portions of the codebase
• Changing the project structure or build system
• Database schema changes or migrations

4. New feature proposals

• Significant new features that would expand the project's scope
• Integration with external services or APIs
• Authentication/authorization systems

5. Breaking changes

• Any changes that break backward compatibility
• Deprecation of existing features
• Changes to public APIs or interfaces

6. Security-related changes

• Security patches or vulnerability fixes
• Authentication/authorization improvements
• Data privacy enhancements

7. Documentation updates

• Major rewrites of documentation
• Translation of documentation into new languages

• Structural changes to documentation

• PRs that involve integrating with third-party services (e.g., Dropbox, Google Drive) without a clear use case that benefits the core translation functionality.

• PRs that add new file format support without sufficient justification or demand from the community.
• PRs that significantly alter the project's scope or direction (e.g., turning it into a general-purpose document editor).
• PRs that introduce new dependencies without a strong rationale or that conflict with the project's lightweight philosophy.
• PRs that are purely cosmetic changes without functional improvements.
• PRs that are not aligned with the project's goals of being a simple, efficient PDF translation tool.

TRANSLATION RESULT

1. PR liés à la fonctionnalité de partage multi-utilisateur. (Ce projet est principalement conçu pour une utilisation mono-utilisateur et n'a pas l'intention d'introduire un système multi-utilisateur complet).
2. PR qui impliquent l'intégration avec des services tiers (par exemple, Dropbox, Google Drive) sans un cas d'utilisation clair qui bénéficie à la fonctionnalité de traduction principale.
3. PR qui ajoutent la prise en charge de nouveaux formats de fichiers sans justification suffisante ou demande de la communauté.
4. PR qui modifient considérablement la portée ou la direction du projet (par exemple, le transformer en un éditeur de documents à usage général).
5. PR qui introduisent de nouvelles dépendances sans justification solide ou qui entrent en conflit avec la philosophie légère du projet.
6. PR qui sont des changements purement cosmétiques sans améliorations fonctionnelles.
7. PR qui ne sont pas alignés avec les objectifs du projet d'être un outil de traduction PDF simple et efficace.

Processus de contribution

1. Forkez ce dépôt et clonez-le localement.
2. Créez une nouvelle branche : git checkout -b feature/<feature-name>.
3. Développez et assurez-vous que votre code répond aux exigences.
4. Validez votre code :

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

5. Poussez vers votre dépôt : git push origin feature/<feature-name>.
6. Créez une PR sur GitHub, fournissez une description détaillée et demandez une revue à @awwaawwa.
7. Assurez-vous que toutes les vérifications automatisées passent.

Exigences de base

1. Flux de travail

• Veuillez forker à partir de la branche main et développer sur votre branche forké.
• Lors de la soumission d'une Pull Request (PR), fournissez une description détaillée de vos modifications.
• Si votre PR ne passe pas les vérifications automatisées (indiquées par checks failed et une croix rouge), veuillez consulter les details correspondants et modifier votre soumission pour vous assurer que la nouvelle PR passe toutes les vérifications.

2. Développement et tests

• Utilisez la commande pip install -e . pour le développement et les tests.

3. Formatage du code

• Configurez l'outil pre-commit et activez black et flake8 pour le formatage du code.

4. Mises à jour des dépendances

• Si vous introduisez de nouvelles dépendances, veuillez mettre à jour la liste des dépendances dans le fichier pyproject.toml en temps opportun.

5. Mises à jour de la documentation

• Si vous ajoutez de nouvelles options de ligne de commande, veuillez mettre à jour la liste des options de ligne de commande dans toutes les versions linguistiques du fichier README.md en conséquence.

6. Messages de commit

• Utilisez Conventional Commits, par exemple : feat(translator): add openai.

7. Style de codage

• Assurez-vous que le code soumis respecte les normes de base de style de codage.
• Utilisez soit snake_case soit camelCase pour la dénomination des variables.

8. Formatage de la documentation

• Pour le formatage de README.md, veuillez suivre les Chinese Copywriting Guidelines.
• Assurez-vous que la documentation en anglais et en chinois est toujours à jour ; les mises à jour de la documentation dans d'autres langues sont facultatives.

Ajout d'un moteur de traduction

1. Ajoutez une nouvelle classe de configuration de traducteur dans le fichier pdf2zh/config/translate_engine_model.py.
2. Ajoutez une instance de la nouvelle classe de configuration de traducteur à l'alias de type TRANSLATION_ENGINE_SETTING_TYPE dans le même fichier.
3. Ajoutez la nouvelle classe d'implémentation du traducteur dans le dossier pdf2zh/translator/translator_impl.

Structure du projet

• config folder : Système de configuration.
• translator folder : Implémentations liées au traducteur.
• gui.py : Fournit l'interface GUI.
• const.py : Quelques constantes.
• main.py : Fournit l'outil en ligne de commande.
• high_level.py : Interfaces de haut niveau basées sur BabelDOC.
• http_api.py : Fournit l'API HTTP (non démarrée).

Demandez à l'IA de comprendre le projet : DeepWiki

Nous contacter

Si vous avez des questions, veuillez soumettre vos commentaires via Issue ou rejoindre notre groupe Telegram. Merci pour votre contribution !