Guía para contribuir en la traducción

¡Muchas gracias por tu interés en participar de la traducción de la documentación oficial de Python al Español! Necesitamos mucho de tu ayuda para poder seguir adelante con este proyecto.

Nota

Si tienes cualquier duda, puedes enviarnos un email a docs-es@python.org.

  1. Crea un fork del repositorio.

    Nota

    Puedes consular la ayuda oficial de GitHub, si lo deseas.

  2. Clona el fork del repositorio que acabas de crear:

    git clone git@github.com:<TU-USUARIO>/python-docs-es.git

  3. Ingresa en la carpeta que git clone creó en tu computadora:

    cd python-docs-es/

  4. Agrega el repositorio original como «upstream»:

    git remote add upstream https://github.com/pycampes/python-docs-es.git

  5. Crea una branch nueva en base al artículo en el que vayas a trabajar. Por ejemplo, si vas a trabajar en el archivo glosario.po, usa un nombre similar a:

    git checkout -b traduccion-glosario

  6. Una vez que hayas elegido el archivo, lo puedes abrir con el editor poedit y empezar a traducir.

  7. Cuando hayas terminado tu sesión, debes guardar tus cambios y enviarlos a GitHub de nuevo:

    git commit -am 'Traducido archivo {nombre de archivo}'
git push origin traduccion-glosario

  8. No olvides añadir tu nombre al archivo TRANSLATORS si no lo has hecho todavía. Los nombres se encuentran ordenados alfabéticamente por apellido.

  9. Luego ve a tu página de GitHub y propone hacer un Pull Request.

    Nota

    Puedes consultar la ayuda oficial de GitHub para crear un Pull Request si lo deseas.

¿Qué archivo traducir?

Tenemos una lista de issues en GitHub en dónde vamos coordinando el trabajo realizado para no traducir dos veces lo mismo. El proceso para traducir un archivo es el siguiente:

  1. Elige cualquier de los que no están asignados a otra persona.

  2. Deja un comentario en el issue diciendo que quieres trabajar en él.

  3. Espera a que un administrador te asigne el issue.

  4. ¡Empieza a traducir!

A tener en cuenta

  • No debes traducir el contenido de :ref:... y :term:....

  • Si tienes que palabras en inglés, debes ponerlas en italics (rodeadas por asteristicos)

  • Si traduces un título que es un link, por favor traduce el link también (por ejemplo un artículo a Wikipedia). En caso de que no haya una traducción del artículo en Wikipedia, deja el título sin traducir.

  • Tenemos una Memoria de Traducción, que usamos para tener consistencia con algunos términos.

Nota

También puedes unirte a nuestro canal de Telegram si necesitas ayuda.

Previsualizar los cambios

Hay dos formas de visualizar, junto con el resultado final de la documentación, los cambios que has hecho.

Read the Docs

Una vez que hayas hecho un Pull Request en GitHub, este mostrará al final de página una sección de «check». Ahí, debería haber uno que diga docs/readthedocs.org:python-docs-es, y al lado un link de «Details». Haciendo click en ese link, deberías poder ver una versión de la documentación con tus cambios.

Construcción local

Desde el mismo directorio python-docs-es/ que se creó cuando hiciste git clone, puedes ejecutar:

make build

Este comando demorará unos minutos y generará toda la documentación en formato HTML en tu computadora. Puedes ver el con tu navegador de internet (Firefox, Chrome, etc) ejecutando:

make serve

Y luego accediendo a http://localhost:8000/