|
| 1 | +:orphan: |
| 2 | + |
| 3 | +Guía para contribuir en la traducción |
| 4 | +===================================== |
| 5 | + |
| 6 | +¡Muchas gracias por tu interés en participar de la traducción de la |
| 7 | +documentación oficial de Python al Español! Necesitamos *mucho* de tu ayuda |
| 8 | +para poder seguir adelante con este proyecto. Te damos la bienvenida y |
| 9 | +te agradecemos anticipadamente por tus futuras colaboraciones. |
| 10 | + |
| 11 | +Este es el grupo de trabajo para la traducción de la |
| 12 | +documentación oficial de Python al Español, todo el contenido de la traducción |
| 13 | +es mantenido por voluntaries que aportan su tiempo y trabajo a la comunidad. |
| 14 | + |
| 15 | +Antes de comenzar tu primera traducción, y que sigas con esta guia de |
| 16 | +contribución, queremos señalar algunos lineamientos generales. |
| 17 | + |
| 18 | +- Esta traducción es mantenida por personas de todo el mundo que hablan el |
| 19 | + idioma Español. No queremos atarla a ninguna región en particular y creemos |
| 20 | + que es un valor extra la diversidad de la misma. Vas a encontrar secciones |
| 21 | + con diferentes tonalidades de países, regiones o estilos. Lo único que pedimos |
| 22 | + es consistencia dentro de un mismo módulo o sección (es decir no cambiar de |
| 23 | + estilo de un párrafo a otro, por ejemplo) y siempre intentar que la persona del |
| 24 | + otro lado pueda entender lo que estamos escribiendo (no usar lunfardo o |
| 25 | + regionalismos muy propios de un único lugar). |
| 26 | + |
| 27 | +- La documentación es ENORME, cualquier traba que encuentres siempre puedes |
| 28 | + marcar el texto como “fuzzy” o para revisar en el futuro. |
| 29 | + No pierdas horas buscando la palabra perfecta. |
| 30 | + |
| 31 | +- En muchos casos el mejor criterio es pensar en el vocabulario que utilizamos |
| 32 | + cuando le explicamos a otra persona, o en el trabajo. En muchas ocasiones la |
| 33 | + versión en inglés o “spanglish” de la palabra es mucho mejor que decir “git |
| 34 | + unir” (para git merge). |
| 35 | + |
| 36 | +- Siempre vas a tener un review de lo que propongas y en ese intercambio otras |
| 37 | + personas van a ayudarte a destrabar las dudas que tengas. |
| 38 | + |
| 39 | +- Colaborar haciendo reviews también es muy muy importante, así que si |
| 40 | + tienes un rato libre puedes comenzar por mirar los PRs pendientes de revisar. |
| 41 | + |
| 42 | +- Último pero no menos importante, divertite y contá con la ayuda de todes. Te |
| 43 | + esperamos en nuestro chat en telegram. ¡Gracias! |
| 44 | + |
| 45 | + |
| 46 | +..note:: |
| 47 | + |
| 48 | + Si tienes cualquier duda, puedes enviarnos un email a docs-es@python.org. |
| 49 | + |
| 50 | + |
| 51 | +¡Comienza a traducir! |
| 52 | +--------------------- |
| 53 | + |
| 54 | +#. Crea un fork delrepositorio_. |
| 55 | + |
| 56 | + ..note:: |
| 57 | + |
| 58 | + Puedes consular la `ayuda oficial de GitHub`_, si lo deseas. |
| 59 | + |
| 60 | +#. Clona el fork del repositorio que acabas de crear:: |
| 61 | + |
| 62 | + git clone git@github.com:<TU-USUARIO>/python-docs-es.git |
| 63 | + |
| 64 | +#. Ingresa en la carpeta que `git clone` creó en tu computadora:: |
| 65 | + |
| 66 | + cd python-docs-es/ |
| 67 | + |
| 68 | +#. Agrega el repositorio original como "upstream":: |
| 69 | + |
| 70 | + git remote add upstream https://github.com/python/python-docs-es.git |
| 71 | + |
| 72 | +#. Crea una rama nueva en base al artículo en el que vayas a trabajar. Por |
| 73 | + ejemplo, si vas a trabajar en el archivo ``glosario.po``, usa un nombre |
| 74 | + similar a:: |
| 75 | + |
| 76 | + git checkout -b traduccion-glosario |
| 77 | + |
| 78 | +#. Una vez que hayas elegido el archivo, lo puedes abrir con el editorpoedit_ y |
| 79 | + empezar a traducir. |
| 80 | + |
| 81 | +#. Cuando hayas terminado tu sesión, debes guardar tus cambios y enviarlos a |
| 82 | + GitHub de nuevo:: |
| 83 | + |
| 84 | + git commit -am 'Traducido archivo {nombre de archivo}' git push origin |
| 85 | + traduccion-glosario |
| 86 | + |
| 87 | +#. No olvides añadir tu nombre al archivo ``TRANSLATORS`` si no lo has hecho |
| 88 | + todavía. Los nombres se encuentran ordenados alfabéticamente por apellido. |
| 89 | + |
| 90 | +#. Luego ve a tu página de GitHub y propone hacer un *Pull Request*. |
| 91 | + |
| 92 | + ..note:: |
| 93 | + |
| 94 | + Puedes consultar la `ayuda oficial de GitHub para crear un Pull Request`_ |
| 95 | + si lo deseas. |
| 96 | + |
| 97 | +#. En la descripción de la *Pull Request* escribe ``Closes #<número de issue>`` |
| 98 | + (así se cierra automáticamente cuando se hace *merge*) |
| 99 | + |
| 100 | + ..note:: |
| 101 | + |
| 102 | + Si hace tiempo que venis trabajando en una traducción es importante |
| 103 | +:ref:`mantener actualizada<mantener-actualizada>` tu copia local antes de realizar el *Pull Request*. |
| 104 | + |
| 105 | + |
| 106 | +¿Qué archivo traducir? |
| 107 | +---------------------- |
| 108 | + |
| 109 | +Tenemos una `lista de issues en GitHub`_ en dónde vamos coordinando el trabajo |
| 110 | +realizado para no traducir dos veces lo mismo. El proceso para traducir un |
| 111 | +archivo es el siguiente: |
| 112 | + |
| 113 | + |
| 114 | +#. Elige cualquier de los que *no están asignados* a otra persona. |
| 115 | +#. Deja un comentario en el issue diciendo que quieres trabajar en él. |
| 116 | +#. Espera a que un administrador te asigne el issue. |
| 117 | +#. ¡Empieza a traducir! |
| 118 | + |
| 119 | + |
| 120 | + |
| 121 | +A tener en cuenta |
| 122 | +----------------- |
| 123 | + |
| 124 | +* No debes traducir el contenido de ``:ref:...`` y ``:term:...``. |
| 125 | + |
| 126 | +* Si tienes que usar palabras en inglés debes ponerlas en *italics* (rodeadas |
| 127 | + por asteriscos) |
| 128 | + |
| 129 | +* Puedes revisar las:doc:`faq` para leer sobre problemas conocidos. |
| 130 | + |
| 131 | +* Si traduces un título que es un link, por favor traduce el link también (por |
| 132 | + ejemplo un artículo a Wikipedia). En caso de que no haya una traducción del |
| 133 | + artículo en Wikipedia deja el título sin traducir. |
| 134 | + |
| 135 | +* Tenemos una `Memoria de Traducción`_, que usamos para tener consistencia con |
| 136 | + algunos términos. |
| 137 | + |
| 138 | +* Si tienes una duda sobre una palabra o término, escríbelo como mejor suene |
| 139 | + para vos y marca ese párrafo como "Need work" / "Necesita trabajo" en |
| 140 | + *poedit*. Además, escribe un comentario explicando cuál es el termino en ese |
| 141 | + párrafo con el que no estabas segura. |
| 142 | + |
| 143 | +* Puedes usar `la traducción al Portugués`_ para ver cómo ellos hicieron la |
| 144 | + traducción de alguna palabra. |
| 145 | + |
| 146 | +* Wikipedia puede ser útil también. Busca la palabra en Inglés, y luego mira si |
| 147 | + tiene una traducción al Español en la barra de la izquierda. Suelen estar |
| 148 | + bastante bien explicados. |
| 149 | + |
| 150 | +* Te recomendamos abrir una Pull Request aunque sea en formato borrador (marcada |
| 151 | + como draft) desde los primeros commits de la traducción de tu fichero. De esta |
| 152 | + forma, puedes recibir feedback desde el principio que puedes aplicar al resto |
| 153 | + de la traducción, y probar el build más a menudo. |
| 154 | + |
| 155 | + |
| 156 | +..note:: |
| 157 | + |
| 158 | + También puedes unirte a `nuestro canal de Telegram`_ si necesitas ayuda. |
| 159 | + |
| 160 | + |
| 161 | +Previsualizar los cambios |
| 162 | +------------------------- |
| 163 | + |
| 164 | +Una vez que hayas hecho un *Pull Request* en GitHub, este mostrará al final de página una sección de "check". |
| 165 | +Allí debería haber uno que diga ``docs/readthedocs.org:python-docs-es`` y al lado un link de "Details". |
| 166 | + |
| 167 | +..figure::readthedocs-preview.png |
| 168 | +:width:85% |
| 169 | +:align:center |
| 170 | + |
| 171 | +Haciendo click en ese link verás una versión de la documentación completa que incluirá todos tus cambios. |
| 172 | +Tendrás que navegar hasta el archivo que hayas cambiado para ver cómo se visualiza luego del build. |
| 173 | + |
| 174 | + |
| 175 | +.. _repositorio:https://github.com/python/python-docs-es |
| 176 | +.. _ayuda oficial de GitHub: |
| 177 | +https://help.github.com/es/github/getting-started-with-github/fork-a-repo |
| 178 | +.. _ayuda oficial de GitHub para crear un Pull Request: |
| 179 | +https://help.github.com/es/github/collaborating-with-issues-and-pull-requests/about-pull-requests |
| 180 | +.. _poedit:https://poedit.net/ |
| 181 | + |
| 182 | +.. _nuestro canal de Telegram:https://t.me/python_docs_es |
| 183 | +.. _Memoria de traducción: |
| 184 | +https://python-docs-es.readthedocs.io/page/translation-memory.html |
| 185 | +.. _la traducción al Portugués:https://docs.python.org/pt-br/3/ |
| 186 | +.. _lista de issues en GitHub: |
| 187 | +https://github.com/python/python-docs-es/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+no%3Aassignee+translate |