Skip to content

Commit f69d097

Browse files
authored
Merge pull request #366 from python/fix-render-contributing
2 parents 0b4eb03 + 947269e commit f69d097

File tree

1 file changed

+49
-35
lines changed

1 file changed

+49
-35
lines changed

.overrides/CONTRIBUTING.rst

+49-35
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,56 @@
11
:orphan:
22

3-
Guía para contribuir en la traducción
3+
Guía para contribuir en la traducción
44
=====================================
55

66
¡Muchas gracias por tu interés en participar de la traducción de la
77
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.
8+
para poder seguir adelante con este proyecto. Te damos la bienvenida y
9+
te agradecemos anticipadamente por tus futuras colaboraciones.
1010

1111
Este es el grupo de trabajo para la traducción de la
1212
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.
13+
es mantenido por voluntaries que aportan su tiempo y trabajo a la comunidad.
1414

15-
Antes de comenzar tu primera traducción y que sigas con esta guia de
16-
contribución queremos señalar algunos lineamientos generales.
15+
Antes de comenzar tu primera traducción, y que sigas con esta guia de
16+
contribución, queremos señalar algunos lineamientos generales.
1717

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

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

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

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

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

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

4545

4646
.. note::
4747

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

5050

51+
¡Comienza a traducir!
52+
---------------------
53+
5154
#. Crea un fork del repositorio_.
5255

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

97100

98-
¿Qué archivo traducir?
101+
¿Qué archivo traducir?
99102
----------------------
100103

101104
Tenemos una `lista de issues en GitHub`_ en dónde vamos coordinando el trabajo
102105
realizado para no traducir dos veces lo mismo. El proceso para traducir un
103106
archivo es el siguiente:
104107

105108

106-
#. Elige cualquier de los que *no están asignados* a otra persona. #. Deja un
107-
comentario en el issue diciendo que quieres trabajar en él. #. Espera a que
108-
un administrador te asigne el issue. #. ¡Empieza a traducir!
109+
#. Elige cualquier de los que *no están asignados* a otra persona.
110+
#. Deja un comentario en el issue diciendo que quieres trabajar en él.
111+
#. Espera a que un administrador te asigne el issue.
112+
#. ¡Empieza a traducir!
109113

110114

111115

112-
A tener en cuenta
116+
A tener en cuenta
113117
-----------------
114118

115-
* No debes traducir el contenido de ``:ref:...`` y ``:term:...``. * Si tienes
116-
que usar palabras en inglés debes ponerlas en *italics* (rodeadas por
117-
asteriscos) * Puedes revisar las :doc:`faq` para leer sobre problemas
118-
conocidos. * Si traduces un título que es un link, por favor traduce el link
119-
también (por ejemplo un artículo a Wikipedia). En caso de que no haya una
120-
traducción del artículo en Wikipedia deja el título sin traducir. * Tenemos
121-
una `Memoria de Traducción`_, que usamos para tener consistencia con algunos
122-
términos. * Si tienes una duda sobre una palabra o término, escríbelo como
123-
mejor suene para vos y marca ese párrafo como "Need work" / "Necesita trabajo"
124-
en *poedit*. Además, escribe un comentario explicando cuál es el termino en
125-
ese párrafo con el que no estabas segura. * Puedes usar `la traducción al
126-
Portugués`_ para ver cómo ellos hicieron la traducción de alguna palabra. *
127-
Wikipedia puede ser útil también. Busca la palabra en Inglés, y luego mira si
119+
* No debes traducir el contenido de ``:ref:...`` y ``:term:...``.
120+
121+
* Si tienes que usar palabras en inglés debes ponerlas en *italics* (rodeadas
122+
por asteriscos)
123+
124+
* Puedes revisar las :doc:`faq` para leer sobre problemas conocidos.
125+
126+
* Si traduces un título que es un link, por favor traduce el link también (por
127+
ejemplo un artículo a Wikipedia). En caso de que no haya una traducción del
128+
artículo en Wikipedia deja el título sin traducir.
129+
130+
* Tenemos una `Memoria de Traducción`_, que usamos para tener consistencia con
131+
algunos términos.
132+
133+
* Si tienes una duda sobre una palabra o término, escríbelo como mejor suene
134+
para vos y marca ese párrafo como "Need work" / "Necesita trabajo" en
135+
*poedit*. Además, escribe un comentario explicando cuál es el termino en ese
136+
párrafo con el que no estabas segura.
137+
138+
* Puedes usar `la traducción al Portugués`_ para ver cómo ellos hicieron la
139+
traducción de alguna palabra.
140+
141+
* Wikipedia puede ser útil también. Busca la palabra en Inglés, y luego mira si
128142
tiene una traducción al Español en la barra de la izquierda. Suelen estar
129143
bastante bien explicados.
130144

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

136150

137-
Previsualizar los cambios
151+
Previsualizar los cambios
138152
-------------------------
139153

140154
Hay dos formas de visualizar, junto con el resultado final de la documentación,
141155
los cambios que has hecho.
142156

143-
Read the Docs
157+
Read the Docs
144158
`````````````
145159

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

153-
Construcción local
167+
Construcción local
154168
``````````````````
155169

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

0 commit comments

Comments
 (0)