Contribuir al proyecto

¡Gracias por tu interés en este proyecto! Antes de empezar a contribuir, por favor tómate un tiempo para leer las siguientes pautas para asegurar que tu contribución pueda ser aceptada sin problemas.

Tipos de contribuciones no aceptadas

1. Internacionalización/traducción de documentación
2. Contribuciones relacionadas con la infraestructura central, como la API HTTP, etc.
3. Problemas marcados explícitamente como "No se necesita ayuda" (incluyendo problemas en el repositorio Byaidu/PDFMathTranslate).
4. Otras contribuciones consideradas inapropiadas por los mantenedores.
5. Contribuir a la documentación, pero cambiar la documentación en idiomas distintos al inglés.

Por favor NO envíes PRs relacionados con los tipos mencionados anteriormente.

Proceso de contribución

1. Haz un fork de este repositorio y clónalo localmente.
2. Crea una nueva rama: git checkout -b feature/<feature-name>.
3. Desarrolla y asegúrate de que tu código cumple con los requisitos.
4. Haz commit de tu código:

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

5. Haz push a tu repositorio: git push origin feature/<feature-name>.
6. Crea un PR en GitHub, proporciona una descripción detallada y solicita una revisión a @awwaawwa.
7. Asegúrate de que todas las verificaciones automáticas pasan.

Requisitos básicos

1. Flujo de trabajo

• Por favor, haz un fork desde la rama main y desarrolla en tu rama bifurcada.
• Al enviar un Pull Request (PR), proporciona una descripción detallada de tus cambios.
• Si tu PR no pasa las verificaciones automáticas (indicado por checks failed y una cruz roja), revisa los details correspondientes y modifica tu envío para asegurar que el nuevo PR pase todas las verificaciones.

2. Desarrollo y Pruebas

• Usa el comando pip install -e . para desarrollo y pruebas.

3. Formateo de código

• Configurar la herramienta pre-commit y habilitar black y flake8 para el formato del código.

4. Actualizaciones de dependencias

• Si introduces nuevas dependencias, actualiza la lista de dependencias en el archivo pyproject.toml de manera oportuna.

5. Actualizaciones de documentación

• Si añades nuevas opciones de línea de comandos, actualiza la lista de opciones de línea de comandos en todas las versiones de idioma del archivo README.md correspondientemente.

6. Mensajes de commit

• Usa Conventional Commits, por ejemplo: feat(translator): add openai.

7. Estilo de codificación

• Asegúrate de que el código enviado cumpla con los estándares básicos de estilo de codificación.
• Utiliza snake_case o camelCase para el nombrado de variables.

8. Formato de documentación

• Para el formato de README.md, sigue las Directrices de redacción en chino.
• Asegúrate de que tanto la documentación en inglés como en chino estén siempre actualizadas; las actualizaciones de documentación en otros idiomas son opcionales.

Añadir un motor de traducción

1. Añade una nueva clase de configuración del traductor en el archivo pdf2zh/config/translate_engine_model.py.
2. Añade una instancia de la nueva clase de configuración del traductor al alias de tipo TRANSLATION_ENGINE_SETTING_TYPE en el mismo archivo.
3. Añade la nueva clase de implementación del traductor en la carpeta pdf2zh/translator/translator_impl.

Estructura del proyecto

• config folder: Sistema de configuración.
• translator folder: Implementaciones relacionadas con el traductor.
• gui.py: Proporciona la interfaz gráfica de usuario.
• const.py: Algunas constantes.
• main.py: Proporciona la herramienta de línea de comandos.
• high_level.py: Interfaces de alto nivel basadas en BabelDOC.
• http_api.py: Proporciona API HTTP (no iniciado).

Contáctanos

Si tienes alguna pregunta, por favor envía tus comentarios a través de un Issue o únete a nuestro grupo de Telegram. ¡Gracias por tu contribución!