33Guía para contribuir en la traducción
44=====================================
55
6- ¡Muchas gracias por tu interés en participar de la traducción de la documentación oficial de Python al Español!
7- Necesitamos *mucho * de tu ayuda para poder seguir adelante con este proyecto.
6+ ¡Muchas gracias por tu interés en participar de la traducción de la
7+ documentación oficial de Python al Español!
8+
9+ Este es el grupo de trabajo para la traducción de la
10+ documentación oficial de Python al Español, todo el contenido de la traducción
11+ es mantenido por voluntaries que aportan su tiempo y trabajo a la comunidad.
12+
13+ Antes de comenzar tu primera traducción, y que sigas con esta guia de
14+ contribución, queremos señalar algunos
15+ :ref: `lineamientos generales <a-tener-en-cuenta >`.
816
917.. note ::
1018
1119 Si tienes cualquier duda, puedes enviarnos un email a docs-es@python.org.
1220
21+ Antes de comenzar
22+ -----------------
1323
14- #. Crea un fork del repositorio _.
24+ #. Para enviar una traducción, necesitas tener un **fork ** del repositorio _
25+ oficial, haciendo click en el botón encerrado en rojo.
26+
27+ .. image :: fork.png
28+ :alt: botón fork
1529
1630 .. note ::
1731
@@ -27,38 +41,77 @@ Necesitamos *mucho* de tu ayuda para poder seguir adelante con este proyecto.
2741
2842#. Agrega el repositorio original como "upstream"::
2943
30- git remote add upstream https://github.com/pycampes/python-docs-es.git
44+ git remote add upstream https://github.com/python/python-docs-es.git
45+
46+ #. (Opcional) Crea un entorno virtual y actívalo::
47+
48+ python -m venv env
49+ source env/bin/activate # macOS y Linux
50+ env\Scripts\activate.bat # Windows
51+
52+ #. (Opcional) Instala los requerimientos del proyecto::
53+
54+ pip install -r requirements.txt
55+
56+ .. note::
3157
32- #. Crea una rama nueva en base al artículo en el que vayas a trabajar.
33- Por ejemplo, si vas a trabajar en el archivo ``glosario.po ``, usa un nombre similar a::
58+ Al tener instalado los requerimientos, podrás utilizas las herramientas
59+ ``powrap`` y ``pospell`` para poder verificar tus archivos traducidos,
60+ y también construir la documentación localmente.
61+
62+ ¡Comienza a traducir!
63+ ---------------------
64+
65+ #. Selecciona un :ref: `archivo para traducir <que-archivo-traducir >`.
66+
67+ #. Verifica que estás en la rama principal del repositorio, **3.8 ** (esto es muy
68+ importante para evitar crear una nueva rama a partir de una traducción
69+ anterior)::
70+
71+ git checkout 3.8
72+
73+ #. Crea una rama nueva en base al artículo en el que vayas a trabajar. Por
74+ ejemplo, si vas a trabajar en el archivo ``library/glosario.po ``, usa un nombre
75+ similar a::
3476
3577 git checkout -b traduccion-glosario
3678
37- #. Una vez que hayas elegido el archivo, lo puedes abrir con el editor poedit _ y empezar a traducir.
79+ #. Una vez que hayas elegido el archivo, lo puedes abrir con el editor poedit _ y
80+ empezar a traducir.
3881
39- #. Cuando hayas terminado tu sesión, debes guardar tus cambios y enviarlos a GitHub de nuevo::
82+ #. Cuando hayas terminado tu sesión, debes guardar tus cambios y enviarlos a
83+ GitHub (No olvides añadir tu nombre al archivo ``TRANSLATORS ``)::
4084
41- git commit -am 'Traducido archivo {nombre de archivo}'
85+ git add library/glosario.po
86+ git commit -m 'Traducido archivo library/glosario'
4287 git push origin traduccion-glosario
4388
44- #. No olvides añadir tu nombre al archivo ``TRANSLATORS `` si no lo has hecho todavía.
45- Los nombres se encuentran ordenados alfabéticamente por apellido.
89+ .. note ::
4690
47- #. Luego ve a tu página de GitHub y propone hacer un *Pull Request *.
91+ Mira los mensajes que el último comando imprimirá por pantalla,
92+ pues encontrarás un enlace para abrir un nuevo Pull-request directamente.
4893
49- .. note ::
94+ Puedes consultar la `ayuda oficial de GitHub para crear un Pull Request `_
95+ si lo deseas.
5096
51- Puedes consultar la `ayuda oficial de GitHub para crear un Pull Request `_ si lo deseas.
5297
5398#. En la descripción de la *Pull Request * escribe ``Closes #<número de issue> ``
5499 (así se cierra automáticamente cuando se hace *merge *)
55100
101+ .. note ::
102+
103+ Si hace tiempo que venis trabajando en una traducción es importante
104+ :ref: `mantener actualizada <mantener-actualizada >` tu copia local antes
105+ de realizar el *Pull Request *.
106+
107+ .. _que-archivo-traducir :
56108
57109¿Qué archivo traducir?
58110----------------------
59111
60- Tenemos una `lista de issues en GitHub `_ en dónde vamos coordinando el trabajo realizado para no traducir dos veces lo mismo.
61- El proceso para traducir un archivo es el siguiente:
112+ Tenemos una `lista de issues en GitHub `_ en dónde vamos coordinando el trabajo
113+ realizado para no traducir dos veces lo mismo. El proceso para traducir un
114+ archivo es el siguiente:
62115
63116
64117#. Elige cualquier de los que *no están asignados * a otra persona.
@@ -67,62 +120,98 @@ El proceso para traducir un archivo es el siguiente:
67120#. ¡Empieza a traducir!
68121
69122
123+ .. _a-tener-en-cuenta :
70124
71125A tener en cuenta
72126-----------------
73127
74- * No debes traducir el contenido de ``:ref:... `` y ``:term:... ``.
75- * Si tienes que usar palabras en inglés debes ponerlas en *italics * (rodeadas por asteriscos)
76- * Si traduces un título que es un link, por favor traduce el link también (por ejemplo un artículo a Wikipedia).
77- En caso de que no haya una traducción del artículo en Wikipedia deja el título sin traducir.
78- * Tenemos una `Memoria de Traducción `_, que usamos para tener consistencia con algunos términos.
79- * Si tienes una duda sobre una palabra o término, escríbelo como mejor suene para vos y
80- marca ese párrafo como "Need work" / "Necesita trabajo" en *poedit *.
81- Además, escribe un comentario explicando cuál es el termino en ese párrafo con el que no estabas segura.
82- * Puedes usar `la traducción al Portugués `_ para ver cómo ellos hicieron la traducción de alguna palabra.
83- * Wikipedia puede ser útil también. Busca la palabra en Inglés, y luego mira si tiene una traducción
84- al Español en la barra de la izquierda. Suelen estar bastante bien explicados.
128+ * Esta traducción es mantenida por **personas de todo el mundo ** que hablan el
129+ idioma Español. No queremos atarla a ninguna región en particular y creemos
130+ que es un valor extra la diversidad de la misma. Vas a encontrar secciones
131+ con diferentes tonalidades de países, regiones o estilos. Lo único que pedimos
132+ es **consistencia ** dentro de un mismo módulo o sección (es decir no cambiar de
133+ estilo de un párrafo a otro, por ejemplo) y siempre intentar que la persona del
134+ otro lado pueda entender lo que estamos escribiendo (no usar lunfardo o
135+ regionalismos muy propios de un único lugar).
85136
137+ * En muchos casos el **mejor criterio ** es pensar en el vocabulario que utilizamos
138+ cuando le explicamos a otra persona, o en el trabajo. En muchas ocasiones la
139+ versión en inglés o “spanglish” de la palabra es mucho mejor que decir “git
140+ unir” (para git merge).
86141
87- .. note ::
142+ * Siempre vas a tener una **revisión de lo que propongas ** y en ese intercambio otras
143+ personas van a ayudarte a destrabar las dudas que tengas.
88144
89- También puedes unirte a `nuestro canal de Telegram `_ si necesitas ayuda.
145+ * Colaborar **haciendo revisiones ** también es muy muy importante, así que si
146+ tienes un rato libre puedes comenzar por mirar los PRs pendientes de revisar.
147+ (mira la :doc: `Guía del revisor <reviewers-guide >`)
90148
149+ * La documentación es ENORME, cualquier traba que encuentres siempre puedes
150+ marcar el texto como **"fuzzy" ** o para revisar en el futuro.
151+ No pierdas horas buscando la palabra perfecta.
91152
92- Previsualizar los cambios
93- -------------------------
153+ * **No debes ** traducir el contenido de ``:ref:... ``, ``:term:... ``, ``:dfn:... ``, etc.
94154
95- Hay dos formas de visualizar, junto con el resultado final de la documentación, los cambios que has hecho.
155+ * Si tienes que usar palabras en inglés debes ponerlas en *cursiva * (rodeadas
156+ por asteriscos)
96157
97- Read the Docs
98- `````````````
158+ * Puedes revisar las :doc: `Preguntas Frecuentes <faq >` para leer sobre problemas conocidos.
99159
100- Una vez que hayas hecho un Pull Request en GitHub, este mostrará al final de página una sección de "check".
101- Allí debería haber uno que diga ``docs/readthedocs.org:python-docs-es `` y al lado un link de "Details".
160+ * Si **traduces un título que es un enlace **, por favor traduce el link también (por
161+ ejemplo un artículo a Wikipedia). En caso de que no haya una traducción del
162+ artículo en Wikipedia deja el título sin traducir.
163+
164+ * Tenemos una :doc: `Memoria de Traducción <translation-memory >`, que usamos para tener
165+ consistencia con algunos términos.
166+
167+ * Si tienes una **duda sobre una palabra o término **, escríbelo como mejor suene
168+ para vos y marca ese párrafo como "Need work" / "Necesita trabajo" en
169+ *poedit *. Además, escribe un comentario explicando cuál es el termino en ese
170+ párrafo con el que no estabas segura.
171+
172+ * Puedes usar `la traducción al Portugués `_ para ver cómo ellos hicieron la
173+ traducción de alguna palabra.
102174
103- Haciendo click en ese link verás una versión de la documentación con tus cambios.
175+ * Wikipedia puede ser útil también. Busca la palabra en Inglés, y luego mira si
176+ tiene una traducción al Español en la barra de la izquierda. Suelen estar
177+ bastante bien explicados.
104178
105- Construcción local
106- ``````````````````
179+ * Te recomendamos abrir una **Pull Request aunque sea en formato borrador ** (marcada
180+ como draft) desde los primeros commits de la traducción de tu fichero. De esta
181+ forma, puedes recibir feedback desde el principio que puedes aplicar al resto
182+ de la traducción, y probar el build más a menudo.
107183
108- Desde el mismo directorio ``python-docs-es/ `` que se creó cuando hiciste ``git clone `` puedes ejecutar::
184+ * Último pero no menos importante, **divertite y contá con la ayuda de todes **. Te
185+ esperamos en nuestro chat en telegram. ¡Gracias!
109186
110- make build
111187
112- Este comando demorará unos minutos y generará toda la documentación en formato HTML en tu computadora.
113- Puedes ver el resultado con tu navegador de internet (Firefox, Chrome, etc) ejecutando::
188+ .. note ::
189+
190+ También puedes unirte a `nuestro canal de Telegram `_ si necesitas ayuda.
191+
192+
193+ Previsualizar los cambios
194+ -------------------------
195+
196+ Una vez que hayas hecho un *Pull Request * en GitHub, este mostrará al final de página una sección de "check".
197+ Allí debería haber uno que diga ``docs/readthedocs.org:python-docs-es `` y al lado un link de "Details".
114198
115- make serve
199+ .. figure :: readthedocs-preview.png
200+ :width: 85%
201+ :align: center
116202
117- Y luego accediendo a http://localhost:8000/
203+ Haciendo click en ese link verás una versión de la documentación completa que incluirá todos tus cambios.
204+ Tendrás que navegar hasta el archivo que hayas cambiado para ver cómo se visualiza luego del build.
118205
119206
120- .. _repositorio : https://github.com/PyCampES/python-docs-es
121- .. _ayuda oficial de GitHub : https://help.github.com/es/github/getting-started-with-github/fork-a-repo
122- .. _ayuda oficial de GitHub para crear un Pull Request : https://help.github.com/es/github/collaborating-with-issues-and-pull-requests/about-pull-requests
207+ .. _repositorio : https://github.com/python/python-docs-es
208+ .. _ayuda oficial de GitHub :
209+ https://help.github.com/es/github/getting-started-with-github/fork-a-repo
210+ .. _ayuda oficial de GitHub para crear un Pull Request :
211+ https://help.github.com/es/github/collaborating-with-issues-and-pull-requests/about-pull-requests
123212.. _poedit : https://poedit.net/
124213
125214.. _nuestro canal de Telegram : https://t.me/python_docs_es
126- .. _Memoria de traducción : https://python-docs-es.readthedocs.io/page/translation-memory.html
127215.. _la traducción al Portugués : https://docs.python.org/pt-br/3/
128- .. _lista de issues en GitHub : https://github.com/PyCampES/python-docs-es/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc
216+ .. _lista de issues en GitHub :
217+ https://github.com/python/python-docs-es/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+no%3Aassignee+translate
0 commit comments