Paso 0: Configuración de Github¶

Esta configuración la tienes que realizar sólo una vez, y con ellopodrás realizar todas las contribuciones que quieras.

1. Para enviar una traducción, necesitas tener unfork delrepositoriooficial, haciendo click en el botón encerrado en rojo.

   

   Nota

   Puedes consular laayuda oficial de GitHub, si lo deseas.

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

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

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

   cdpython-docs-es/

4. Agrega el repositorio original como «upstream»:

   gitremoteaddupstreamhttps://github.com/python/python-docs-es.git

5. (Opcional) Crea un entorno virtual y actívalo:

   python-mvenvenvsourceenv/bin/activate# macOS y Linuxenv\Scripts\activate.bat# Windows

6. (Opcional) Instala los requerimientos del proyecto:

   pipinstall-rrequirements.txt

   Nota

   Al tener instalado los requerimientos, podrás utilizas las herramientaspowrap ypospell para poder verificar tus archivos traducidos,y también construir la documentación localmente.

Paso 1: ¿Qué archivo traducir?¶

Tenemos unalista de issues en GitHub en dónde vamos coordinando el trabajorealizado para no traducir dos veces lo mismo. El proceso para traducir unarchivo es el siguiente:

1. Elige cualquiera de los issues queno 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!

Paso 2: ¡Comienza a traducir!¶

1. Tener unarchivo asignado para traducir.

2. Verifica que estás en la rama principal del repositorio,3.11 (esto es muyimportante para evitar crear una nueva rama a partir de una traducciónanterior):

   gitcheckout3.11

3. Crea una rama nueva en base al artículo en el que vayas a trabajar. Porejemplo, si vas a trabajar en el archivolibrary/ast.po, usa un nombresimilar a:

   gitcheckout-btraduccion-ast

4. Una vez que hayas elegido el archivo, lo puedes abrir con el editorpoedit yempezar a traducir.

5. Formato de columnas: Si utilizaspoedit es posible que tu archivo tengala estructura adecuada, pero te invitamos a comprobarlo con la herramientapowrap, la cual puedes instalar y utilizar por la línea de comandos.Ejecuta:

   powrap<directorio>/tu_archivo.po

   Recuerda que tu archivo puede estar dentro de un<directorio>, comolibrary, con lo que tendrás que ejecutar el comandopowraplibrary/tu_archivo.po si no te encuentras en el mismo directorio de tuarchivo.

   Nota

   Si estás en Windows y tienes problemas, mira los comentarios deUtilizar powrap en Windows para más información.

6. Corrección ortográfica: Para verificar la ortografía de tu archivopuedes utilizar la herramientapospell para que verifiques que todas laspalabras están aceptadas o incluidas en diccionarios. Para ello tenemosun script de conveniencia que puedes utilizar:

   pythonscripts/check_spell.py<directorio>/tu_archivo.po

   Si alguna palabra no es reconocida, y es una palabra válida, tienes queagregarla al diccionario correspondiente en el directorio dictionaries/.Busca el archivo que corresponde al que estás traduciendo y si no existe, créalo.Por ejemplo el diccionario del archivolibrary/ast.po se encuentra endictionaries/library_ast.po.

   Nota

   Si estás en Windows y tienes problemas, mira los comentarios deUtilizar pospell en Windows para más información.

7. Cuando hayas terminado tu sesión, debes guardar tus cambios y enviarlos aGitHub (No olvides añadir tu nombre al archivoTRANSLATORS).Si estuvieras trabajando en el archivolibrary/ast.po los pasos serían:

   gitaddlibrary/ast.pogitcommit-m'Traducido archivo library/ast'gitpushorigintraduccion-ast

   Nota

   Mira los mensajes que el último comando imprimirá por pantalla,pues encontrarás un enlace para abrir un nuevo Pull-request directamente.

   Puedes consultar laayuda oficial de GitHub para crear un Pull Requestsi lo deseas.

8. En la descripción de laPull Request escribeCloses#<númerodeissue>(así se cierra automáticamente cuando se hacemerge)

   Nota

   Si hace tiempo que venis trabajando en una traducción es importantemantener actualizada tu copia local antesde realizar elPull Request.

A tener en cuenta¶

• Esta traducción es mantenida porpersonas de todo el mundo que hablan elidioma Español. No queremos atarla a ninguna región en particular y creemosque es un valor extra la diversidad de la misma. Vas a encontrar seccionescon diferentes tonalidades de países, regiones o estilos. Lo único que pedimosesconsistencia dentro de un mismo módulo o sección (es decir no cambiar deestilo de un párrafo a otro, por ejemplo) y siempre intentar que la persona delotro lado pueda entender lo que estamos escribiendo (no usar lunfardo oregionalismos muy propios de un único lugar).

• En muchos casos elmejor criterio es pensar en el vocabulario que utilizamoscuando le explicamos a otra persona, o en el trabajo. En muchas ocasiones laversión en inglés o “spanglish” de la palabra es mucho mejor que decir “gitunir” (para git merge).

• Siempre vas a tener unarevisión de lo que propongas y en ese intercambio otraspersonas van a ayudarte a destrabar las dudas que tengas.

• Colaborarhaciendo revisiones también es muy muy importante, así que sitienes un rato libre puedes comenzar por mirar los PRs pendientes de revisar.(mira laGuía del revisor)

• La documentación es ENORME, cualquier traba que encuentres siempre puedesmarcar el texto como«fuzzy» o para revisar en el futuro.No pierdas horas buscando la palabra perfecta.

• No debes traducir el contenido de:ref:...,:term:...,:dfn:..., etc.

• Si tienes que usar palabras en inglés debes ponerlas encursiva (rodeadaspor asteriscos)

• Puedes revisar lasPreguntas Frecuentes para leer sobre problemas conocidos.

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

• Si tienes unaduda sobre una palabra o término, escríbelo como mejor suenepara vos y marca ese párrafo como «Need work» / «Necesita trabajo» enpoedit. Además, escribe un comentario explicando cuál es el termino en esepárrafo con el que no estabas segura.

• Puedes usarla traducción al Portugués para ver cómo ellos hicieron latraducción de alguna palabra.

• Wikipedia puede ser útil también. Busca la palabra en Inglés, y luego mira sitiene una traducción al Español en la barra de la izquierda. Suelen estarbastante bien explicados.

• Te recomendamos abrir unaPull Request aunque sea en formato borrador (marcadacomo draft) desde los primeros commits de la traducción de tu fichero. De estaforma, puedes recibir feedback desde el principio que puedes aplicar al restode la traducción, y probar el build más a menudo.

• Último pero no menos importante,divertite y contá con la ayuda de todes. Teesperamos en nuestro chat en telegram. ¡Gracias!

Previsualizar los cambios¶

Una vez que hayas hecho unPull Request en GitHub, este mostrará al final de página una sección de «check».Allí debería haber uno que digadocs/readthedocs.org:python-docs-es y al lado un link de «Details».

Haciendo click en ese link verás una versión de la documentación completa que incluirá todos tus cambios.Tendrás que navegar hasta el archivo que hayas cambiado para ver cómo se visualiza luego del build.

Memoria de traducción¶

Tenemos unaMemoria de Traducción, que usamos para tener consistencia con algunostérminos.Si tienes alguna duda respecto a cómo traducir alguna palabra no te olvides de revisar este contenido.Del mismo modo, si luego de trabajar sobre un términocomplicado llegas a un acuerdo con otros colaboradores:no se olviden de agregarlo.