Contribuer au projet

Merci de 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. Internationalisation/traduction de la documentation
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 le dépôt Byaidu/PDFMathTranslate).
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.

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

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.

Prérequis de base

1. Flux de travail

• Veuillez forker à partir de la branche main et développer sur votre branche forkée.
• 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 automatiques (indiquées par checks failed et une croix rouge), veuillez examiner 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

• Configurer l'outil pre-commit et activer 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 nomination des variables.

8. Formatage de la documentation

• Pour le formatage de README.md, veuillez suivre les Directives de rédaction en chinois.
• 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.

Ajouter 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

• dossier config : Système de configuration.
• dossier translator : Implémentations liées au traducteur.
• gui.py : Fournit l'interface graphique.
• 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 une API HTTP (non démarrée).

Nous contacter

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