Spaces:
Sleeping
Sleeping
|
Download docs/es/community/Contribution-Guide.md from ryusaksun/PDFTranslate: direct link, hf CLI and curl.
- Browser
- Download file 8.44 kB
-
https://huggingface.co/spaces/ryusaksun/PDFTranslate/resolve/main/docs/es/community/Contribution-Guide.md
- Command line
-
hf download hf://spaces/ryusaksun/PDFTranslate/docs/es/community/Contribution-Guide.md
-
curl -L -o Contribution-Guide.md https://huggingface.co/spaces/ryusaksun/PDFTranslate/resolve/main/docs/es/community/Contribution-Guide.md
8.44 kB
| # Contribuir al proyecto | |
| > [!CAUTION] | |
| > | |
| > Los mantenedores actuales del proyecto est谩n investigando la internacionalizaci贸n automatizada de la documentaci贸n. Por lo tanto, 隆NO se aceptar谩n PRs relacionados con la internacionalizaci贸n/traducci贸n de la documentaci贸n! | |
| > | |
| > 隆Por favor, NO env铆es PRs relacionados con la internacionalizaci贸n/traducci贸n de la documentaci贸n! | |
| 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 API HTTP, etc. | |
| 3. Problemas marcados expl铆citamente como "No se necesita ayuda" (incluyendo problemas en los repositorios [Byaidu/PDFMathTranslate](Byaidu/PDFMathTranslate) y [PDFMathTranslate-next/PDFMathTranslate-next](PDFMathTranslate-next/PDFMathTranslate-next)). | |
| 4. Otras contribuciones consideradas inapropiadas por los mantenedores. | |
| 5. Contribuir a la documentaci贸n, pero modificando 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. | |
| > [!NOTE] | |
| > | |
| > Si deseas contribuir con la documentaci贸n, por favor **solo modifiques la versi贸n en ingl茅s de la documentaci贸n**. Las versiones en otros idiomas son traducidas por los propios colaboradores. | |
| - [ ] Add new translation services | |
| - [ ] Add new features | |
| - [ ] Modify the project structure | |
| --- | |
| ### TRANSLATION RESULT | |
| ## PR que se recomienda discutir con los mantenedores mediante un Issue antes de enviarlo | |
| - [ ] Agregar nuevos servicios de traducci贸n | |
| - [ ] Agregar nuevas caracter铆sticas | |
| - [ ] Modificar la estructura del proyecto | |
| - [ ] Add new translation services | |
| - [ ] Add new features | |
| - [ ] Modify the project structure | |
| --- | |
| ### TRANSLATION RESULT | |
| Para los siguientes tipos de PR, se recomienda discutir primero con los mantenedores antes de enviarlos: | |
| - [ ] Agregar nuevos servicios de traducci贸n | |
| - [ ] Agregar nuevas caracter铆sticas | |
| - [ ] Modificar la estructura del proyecto | |
| 2. PRs that involve modifying the project's core architecture. (We welcome improvements, but please discuss them first). | |
| 3. PRs that add new dependencies. (We aim to keep the project lightweight). | |
| --- | |
| ### TRANSLATION RESULT | |
| 1. PR relacionados con la funcionalidad de uso compartido para 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 para m煤ltiples usuarios). | |
| 2. PR que impliquen modificar la arquitectura central del proyecto. (Damos la bienvenida a las mejoras, pero por favor disc煤telas primero). | |
| 3. PR que agreguen nuevas dependencias. (Nuestro objetivo es mantener el proyecto liviano). | |
| ## 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 cumpla con los requisitos. | |
| 4. Confirma tus cambios: | |
| ```bash | |
| git add . | |
| git commit -m "<semantic commit message>" | |
| ``` | |
| 5. Sube los cambios 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](https://github.com/awwaawwa). | |
| 7. Aseg煤rate de que todas las verificaciones automatizadas pasen. | |
| > [!TIP] | |
| > | |
| > No es necesario esperar hasta que tu desarrollo est茅 completamente terminado para crear un PR. Crear uno temprano nos permite revisar tu implementaci贸n y proporcionar sugerencias. | |
| > | |
| > Si tienes alguna pregunta sobre el c贸digo fuente o asuntos relacionados, por favor contacta al mantenedor en aw@funstory.ai. | |
| > | |
| > Los archivos de recursos para la versi贸n 2.0 se comparten con [BabelDOC](https://github.com/funstory-ai/BabelDOC). El c贸digo para descargar los recursos relacionados est谩 en BabelDOC. Si deseas agregar nuevos archivos de recursos, por favor contacta al mantenedor de BabelDOC en aw@funstory.ai. | |
| ## Requisitos b谩sicos | |
| <h4 id="sop">1. Flujo de trabajo</h4> | |
| - 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 automatizadas (indicadas por `checks failed` y una cruz roja), revisa los `details` correspondientes y modifica tu env铆o para asegurar que la nueva PR pase todas las verificaciones. | |
| <h4 id="dev&test">2. Desarrollo y Pruebas</h4> | |
| - Usa el comando `pip install -e .` para desarrollo y pruebas. | |
| <h4 id="formato">3. Formato de c贸digo</h4> | |
| - Configura la herramienta `pre-commit` y habilita `black` y `flake8` para el formato del c贸digo. | |
| <h4 id="requpdate">4. Actualizaciones de dependencias</h4> | |
| - Si introduces nuevas dependencias, actualiza la lista de dependencias en el archivo `pyproject.toml` de manera oportuna. | |
| <h4 id="docupdate">5. Actualizaciones de documentaci贸n</h4> | |
| - 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` correspondientemente. | |
| <h4 id="commitmsg">6. Mensajes de commit</h4> | |
| - Usa [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), por ejemplo: `feat(translator): add openai`. | |
| <h4 id="codestyle">7. Estilo de codificaci贸n</h4> | |
| - 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. | |
| <h4 id="doctypo">8. Formato de documentaci贸n</h4> | |
| - Para el formato de `README.md`, sigue las [Directrices de redacci贸n en chino](https://github.com/sparanoid/chinese-copywriting-guidelines). | |
| - 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. Agrega una nueva clase de configuraci贸n de traductor en el archivo `pdf2zh/config/translate_engine_model.py`. | |
| 2. Agrega una instancia de la nueva clase de configuraci贸n de traductor al alias de tipo `TRANSLATION_ENGINE_SETTING_TYPE` en el mismo archivo. | |
| 3. Agrega la nueva clase de implementaci贸n de traductor en la carpeta `pdf2zh/translator/translator_impl`. | |
| > [!NOTE] | |
| > | |
| > Este proyecto no tiene la intenci贸n de admitir ning煤n motor de traducci贸n con un RPS (solicitudes por segundo) inferior a 4. Por favor, no env铆e soporte para dichos motores. | |
| > Los siguientes tipos de traductores tampoco se integrar谩n: | |
| > - Traductores que han sido discontinuados por los mantenedores upstream (como deeplx) | |
| > - Traductores con grandes dependencias (como aquellos que dependen de pytorch) | |
| > - Traductores inestables | |
| > - Traductores basados en API de ingenier铆a inversa | |
| > | |
| > Cuando no est茅 seguro de si un traductor cumple con los requisitos, puede enviar un problema para discutirlo con los mantenedores. | |
| ## 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). | |
| Pregunta a la IA para entender el proyecto: [DeepWiki](https://deepwiki.com/PDFMathTranslate-next/PDFMathTranslate-next) | |
| ## Cont谩ctanos | |
| Si tienes alguna pregunta, por favor env铆a tus comentarios a trav茅s de Issue o 煤nete a nuestro Grupo de Telegram. 隆Gracias por tu contribuci贸n! | |
| > [!TIP] | |
| > | |
| > [Immersive Translate](https://immersivetranslate.com) patrocina c贸digos de membres铆a Pro mensuales para los contribuyentes activos de este proyecto. Para m谩s detalles, consulta: [Reglas de recompensa para contribuyentes de BabelDOC/PDFMathTranslate](https://funstory-ai.github.io/BabelDOC/CONTRIBUTOR_REWARD/) | |
| <div align="right"> | |
| <h6><small>Parte del contenido de esta p谩gina ha sido traducido por GPT y puede contener errores.</small></h6> |