Guía para contribuir en la traducción

para poder seguir adelante con este proyecto. Te damos la bienvenida y

te agradecemos anticipadamente por tus futuras colaboraciones.

es mantenido por voluntaries que aportan su tiempo y trabajo a la comunidad.

Antes de comenzar tu primera traducción, y que sigas con esta guia de

contribución, queremos señalar algunos lineamientos generales.

estilo de un párrafo a otro, por ejemplo) y siempre intentar que la persona del

regionalismos muy propios de un único lugar).

- La documentación es ENORME, cualquier traba que encuentres siempre puedes

marcar el texto como “fuzzy” o para revisar en el futuro.

No pierdas horas buscando la palabra perfecta.

- Siempre vas a tener un review de lo que propongas y en ese intercambio otras

personas van a ayudarte a destrabar las dudas que tengas.

(mira la `Guía del revisor`_)

esperamos en nuestro chat en telegram. ¡Gracias!

¡Comienza a traducir!

.. note::

Si hace tiempo que venis trabajando en una traducción es importante

:ref:`mantener actualizada <mantener-actualizada>` tu copia local antes de realizar el *Pull Request*.

¿Qué archivo traducir?

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

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

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

#. ¡Empieza a traducir!

A tener en cuenta

* No debes traducir el contenido de ``:ref:...`` y ``:term:...``.

* Si tienes que usar palabras en inglés debes ponerlas en *italics* (rodeadas

por asteriscos)

* 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.

* Si tienes una duda sobre una palabra o término, escríbelo como mejor suene

para vos y marca ese párrafo como "Need work" / "Necesita trabajo" en

*poedit*. Además, escribe un comentario explicando cuál es el termino en ese

párrafo con el que no estabas segura.

traducción de alguna palabra.

* Wikipedia puede ser útil también. Busca la palabra en Inglés, y luego mira si

tiene una traducción al Español en la barra de la izquierda. Suelen estar

bastante bien explicados.

* Te recomendamos abrir una Pull Request aunque sea en formato borrador (marcada

como draft) desde los primeros commits de la traducción de tu fichero. De esta

forma, puedes recibir feedback desde el principio que puedes aplicar al resto

de la traducción, y probar el build más a menudo.

.. note::

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

Previsualizar los cambios

Una vez que hayas hecho un *Pull Request* en GitHub, este mostrará al final de página una sección de "check".

Allí debería haber uno que diga ``docs/readthedocs.org:python-docs-es`` y al lado un link de "Details".

.. figure:: readthedocs-preview.png

:width: 85%

:align: center

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.

.. _Guía del revisor:

https://python-docs-es.readthedocs.io/page/reviewers-guide.html

¿Cómo agrego una palabra al diccionario?

Si ``pospell`` falla diciendo que no conoce una palabra, pero estamos seguros que esa palabra está bien escrita,

debemos agregarla al diccionario que ``pospell`` usa internamente para comprobar las palabras.

Para eso debes editar (o crear, si no existe) el archivo ``<archivopo>.txt`` dentro del direcorio ``dictionaries``

y agregar esa palabra al final de este archivo.

Nota que debes reemplazar ``<archivopo>`` por el nombre del archivo que estés traduciendo.

Por ejemplo, si estás traduciendo ``library/decimal.po``, debes editar/crear el archivos ``dictionaries/library_decimal.txt``.

.. tip::

Este comando te puede ayudar a cambiar todas las comillas::

¿Cómo puedo hacer un *build* local de la documentación?

.. note::

Necesitas un poco de conocimiento para instalar ``make`` en tu sistema operativo.

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

Este comando demorará unos minutos y generará toda la documentación en formato HTML en tu computadora.

Puedes ver el resultado con tu navegador de internet (Firefox, Chrome, etc) ejecutando::

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

.. _mantener-actualizada:

¿Cómo actualizar mi copia local del repositorio?

Es recomendable mantener actualizada nuestra copia local para evitar

posibles conflictos entre los archivos que trabajamos y la última versión disponible

en el repositorio remoto.

Primero, necesitamos bajar los cambios de *upstream* (es el nombre que asignamos al

repositorio principal de la traducción). Se hace de la siguiente manera::

Luego nos vamos a nuestra rama local, confirmamos e impactamos esos cambios::

¡Eso es todo!

¿Tienen una lista de correo?

Sí.

No tiene mucho tráfico aún ya que estamos usando más el canal de Telegram por el momento.

Puedes suscribirte ingresando aquí_.

.. _aquí: https://mail.python.org/mailman3/lists/docs-es.python.org/

Estas listas se actualiza automáticamente cuando Pull Requests se *mergean* a la rama ``3.8``.

En progreso

Muestra los porcentajes completados por directorio y solo los archivos que no están al 100%.

Completados

Lista todos los archivos con un porcentaje de traducción mayor al 90% (para contemplar los que tienen fuzzy).

.. runblock:: console

$ python scripts/completed_files.py

Guía para revisar una traducción

El costado humano

Teniendo en cuenta que todes somos voluntaries en este proyecto, es importante que la forma de comunicarnos sea clara, concisa y amable. Como revisor/a, ayudarás a voluntaries de diferentes culturas y lugares del mundo para que su traducción sea lo más acertada posible y podamos acercar Python a las comunidades de habla hispana. Recuerda que del otro lado de un PR hay una persona que ha dedicado tiempo y esfuerzo; es por eso es la forma en que le des una devolución sobre su trabajo influirá en su actitud hacia el proyecto…¡y en sus ganas de seguir participando de nuestra comunidad!

Aquí te dejamos algunos *tips* para que tu devolución sea constructiva y genuina:

* Siempre deja un comentario en la PR que deje una conclusión general de tu devolución para dejarle claro a les traductores qué necesita modificación y qué no. Recuerda siempre comenzar reconociendo los aspectos positivos del trabajo de la otra persona y luego puedes agregar comentarios/sugerencias sobre la traducción.

El costado práctico

La devolución deberá ser acertada para transmitir el mensaje que necesitamos que llegue; de esta forma, les traductores podrán revisar su trabajo y saber qué necesitan hacer para mejorarlo.

No olvides que esto se trata de una traducción técnica y como tal, el objetivo es que, básicamente, la persona que la lea pueda entender cómo usar Python. Es por esto que, si bien es importante que la sintaxis sea correcta, el objetivo no es hacer una revisión intensiva del uso del español, a menos que la forma en que se expresó la idea imposibilite que otre la entienda.

Para esto, Github te ofrece opciones para afrontar una PR (ver botón *Review Changes* arriba a la derecha de los archivos modificados por les traductores):

* *Comment*: Puedes dejar un comentario sin necesariamente aprobar la PR. Asegúrate de hacerlo con claridad para que quien tradujo sepa que debe modificar algunas cosas antes de que su PR sea aprobada.

* *Approve*: Dejar esta opción solo para PRs que no necesitan modificación alguna o que solo tengan pocas faltas de ortografía o errores de tipeo, o algún error que no genere un conflicto mayor en la traducción y en su integración al repositorio.

* *Request Changes*: Utiliza esta opción cuando la traducción necesita varias modificaciones que afectan su integración al repositorio. En este caso también asegúrate de que tu mensaje sea claro y amable para acompañar al traductor en el proceso de modificar y lograr que la PR se apruebe.

*Tips*

* PRs de más de 1000 líneas: Te sugerimos hacer un comentario al principio del PR para indicar hasta qué línea haz hecho el review y qué hay que revisar hasta ese hito.

* “Needs work” genera en la línea anterior “#fuzzy” para que el traductor revise esa línea. Se puede usar cuando la traducción necesita revisión y en ese momento no puedes sugerir una traducción alternativa.

El costado técnico

Al revisar una traducción, deberás tener en cuenta ciertos aspectos propios de una traducción técnica de esta índole. Además de que debe entenderse el texto en español y que debes respetar el contenido de la documentación original (ver "A tener en cuenta" en la `Guía para contribuir en la traducción <https://python-docs-es.readthedocs.io/es/3.8/CONTRIBUTING.html>`_), contamos con herramientas en este proyecto que pueden fallar en ciertos casos, y que como revisor/a deberás tener en cuenta.

Cuatro razones por las que puede fallar el *build* de Travis:

* `powrap` falla

* `pospell` falla

* Dict está duplicado

* Sphinx falla