Contribuir al proyecto

Gracias por tu interés en este proyecto. Antes de comenzar 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. Documentación de internacionalización/traducción
2. Contribuciones relacionadas con la infraestructura central, como la API HTTP, etc.
3. Issues marcados explícitamente como "No se necesita ayuda" (incluyendo issues en el repositorio Byaidu/PDFMathTranslate y en el repositorio PDFMathTranslate-next/PDFMathTranslate-next).
4. Otras contribuciones consideradas inapropiadas por los mantenedores.
5. Contribuir a la documentación, pero cambiando la documentación en idiomas distintos al inglés.
6. PRs que requieran modificar archivos PDF.
7. PRs que modifiquen el archivo pdf2zh_next/gui_translation.yaml.

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

PRs que se recomienda discutir con los mantenedores a través de un Issue antes de enviarlos

Para los siguientes tipos de PRs, se recomienda discutir con los mantenedores primero antes de enviarlos:

1. PRs relacionados con la funcionalidad de compartir entre múltiples usuarios. (Este proyecto está diseñado principalmente para uso de un solo usuario y no tiene la intención de introducir un sistema completo de múltiples usuarios).

Proceso de contribución

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

   git add .
   git commit -m "<mensaje de confirmación semántico>"
   

5. Sube a tu repositorio: git push origin feature/<nombre-de-la-funcionalidad>.
6. Crea un PR en GitHub, proporciona una descripción detallada y solicita una revisión a @awwaawwa.
7. Asegúrate de que pasen todas las verificaciones automatizadas.

Requisitos básicos

1. Flujo de trabajo

• Por favor, haz un fork desde la rama main y desarrolla en tu rama bifurcada.
• Al enviar una 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), por favor revisa los details correspondientes y modifica tu envío para asegurar que la nueva 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 formateo del código.

4. Actualizaciones de dependencias

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

5. Actualizaciones de la documentación

• Si agregas nuevas opciones de línea de comandos, por favor actualiza la lista de opciones de línea de comandos en todas las versiones de idioma del archivo README.md en consecuencia.

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 que envías cumpla con los estándares básicos de estilo de codificación.
• Utiliza snake_case o camelCase para nombrar variables.

8. Formato de documentación

• Para el formato de README.md, por favor 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 la documentación en otros idiomas son opcionales.

Agregar un motor de traducción

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

Estructura del proyecto

• carpeta config: Sistema de configuración.
• carpeta translator: Implementaciones relacionadas con traductores.
• 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 iniciada).

Pregunta a la IA para entender el proyecto: DeepWiki

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!