Skip to content

Contributing render #366

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 25, 2020
Merged

Contributing render #366

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 49 additions & 35 deletions .overrides/CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,53 +1,56 @@
:orphan:

Guía para contribuir en la traducción
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. Te damos la bienvenida y
te agradecemos anticipadamente por tus futuras colaboraciones.
para poder seguir adelante con este proyecto. Te damos la bienvenida y
te agradecemos anticipadamente por tus futuras colaboraciones.

Este es el grupo de trabajo para la traducción de la
documentación oficial de Python al Español, todo el contenido de la traducción
es mantenido por voluntaries que aportan su tiempo y trabajo a la comunidad.
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.
Antes de comenzar tu primera traducción, y que sigas con esta guia de
contribución, queremos señalar algunos lineamientos generales.

- Esta traducción es mantenida por personas de todo el mundo que hablan el
idioma Español. No queremos atarla a ninguna región en particular y creemos
que es un valor extra la diversidad de la misma. Vas a encontrar secciones
con diferentes tonalidades de países, regiones o estilos. Lo único que pedimos
es consistencia dentro de un mismo módulo o sección (es decir no cambiar de
estilo de un párrafo a otro por ejemplo) y siempre intentar que la persona del
estilo de un párrafo a otro, por ejemplo) y siempre intentar que la persona del
otro lado pueda entender lo que estamos escribiendo (no usar lunfardo o
regionalismos muy propios de un único lugar)
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.
- 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.

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

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

- Colaborar haciendo reviews también es muy muy importante, así que si
tienes un rato libre puedes comenzar por mirar los PRs pendientes de revisar.

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


.. note::

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


¡Comienza a traducir!
---------------------

#. Crea un fork del repositorio_.

.. note::
Expand Down Expand Up @@ -95,36 +98,47 @@ contribución queremos señalar algunos lineamientos generales.
(así se cierra automáticamente cuando se hace *merge*)


¿Qué archivo traducir?
¿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:


#. 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!
#. 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
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) * Puedes revisar las :doc:`faq` para leer sobre problemas
conocidos. * 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. * Puedes usar `la traducción al
Portugués`_ para ver cómo ellos hicieron la traducción de alguna palabra. *
Wikipedia puede ser útil también. Busca la palabra en Inglés, y luego mira si
* No debes traducir el contenido de ``:ref:...`` y ``:term:...``.

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

* Puedes revisar las :doc:`faq` para leer sobre problemas conocidos.

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

* Puedes usar `la traducción al Portugués`_ para ver cómo ellos hicieron la
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.

Expand All @@ -134,13 +148,13 @@ A tener en cuenta
También puedes unirte a `nuestro canal de Telegram`_ si necesitas ayuda.


Previsualizar los cambios
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
Read the Docs
`````````````

Una vez que hayas hecho un Pull Request en GitHub, este mostrará al final de
Expand All @@ -150,7 +164,7 @@ página una sección de "check". Allí debería haber uno que diga
Haciendo click en ese link verás una versión de la documentación con tus
cambios.

Construcción local
Construcción local
``````````````````

Desde el mismo directorio ``python-docs-es/`` que se creó cuando hiciste ``git
Expand Down