1
+ :orphan:
2
+
1
3
Guía para contribuir en la traducción
2
4
=====================================
3
5
4
- ¡Muchas gracias por tu interés en participar de la traducción de la documentación oficial de Python al Español!
5
- 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! 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
+
6
45
7
46
.. note ::
8
47
9
48
Si tienes cualquier duda, puedes enviarnos un email a docs-es@python.org.
10
49
11
50
51
+ ¡Comienza a traducir!
52
+ ---------------------
53
+
12
54
#. Crea un fork del repositorio _.
13
55
14
56
.. note ::
@@ -25,35 +67,43 @@ Necesitamos *mucho* de tu ayuda para poder seguir adelante con este proyecto.
25
67
26
68
#. Agrega el repositorio original como "upstream"::
27
69
28
- git remote add upstream https://github.com/pycampes /python-docs-es.git
70
+ git remote add upstream https://github.com/python /python-docs-es.git
29
71
30
- #. Crea una branch nueva en base al artículo en el que vayas a trabajar.
31
- Por ejemplo, si vas a trabajar en el archivo ``glosario.po ``, usa un nombre similar a::
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::
32
75
33
76
git checkout -b traduccion-glosario
34
77
35
- #. Una vez que hayas elegido el archivo, lo puedes abrir con el editor poedit _ y empezar a traducir.
78
+ #. Una vez que hayas elegido el archivo, lo puedes abrir con el editor poedit _ y
79
+ empezar a traducir.
36
80
37
- #. Cuando hayas terminado tu sesión, debes guardar tus cambios y enviarlos a GitHub de nuevo::
81
+ #. Cuando hayas terminado tu sesión, debes guardar tus cambios y enviarlos a
82
+ GitHub de nuevo::
38
83
39
- git commit -am 'Traducido archivo {nombre de archivo}'
40
- git push origin traduccion-glosario
84
+ git commit -am 'Traducido archivo {nombre de archivo}' git push origin
85
+ traduccion-glosario
41
86
42
- #. No olvides añadir tu nombre al archivo ``TRANSLATORS `` si no lo has hecho todavía.
43
- Los nombres se encuentran ordenados alfabéticamente por apellido.
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.
44
89
45
- #. Luego ve a tu página de GitHub y propone hacer un Pull Request.
90
+ #. Luego ve a tu página de GitHub y propone hacer un * Pull Request * .
46
91
47
92
.. note ::
48
93
49
- Puedes consultar la `ayuda oficial de GitHub para crear un Pull Request `_ si lo deseas.
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 *)
50
99
51
100
52
101
¿Qué archivo traducir?
53
102
----------------------
54
103
55
- Tenemos una `lista de issues en GitHub `_ en dónde vamos coordinando el trabajo realizado para no traducir dos veces lo mismo.
56
- El proceso para traducir un archivo es el siguiente:
104
+ Tenemos una `lista de issues en GitHub `_ en dónde vamos coordinando el trabajo
105
+ realizado para no traducir dos veces lo mismo. El proceso para traducir un
106
+ archivo es el siguiente:
57
107
58
108
59
109
#. Elige cualquier de los que *no están asignados * a otra persona.
@@ -67,51 +117,66 @@ A tener en cuenta
67
117
-----------------
68
118
69
119
* No debes traducir el contenido de ``:ref:... `` y ``:term:... ``.
70
- * Si tienes que palabras en inglés, debes ponerlas en *italics * (rodeadas por asteristicos)
71
- * Si traduces un título que es un link, por favor traduce el link también (por ejemplo un artículo a Wikipedia).
72
- En caso de que no haya una traducción del artículo en Wikipedia, deja el título sin traducir.
73
- * Tenemos una `Memoria de Traducción `_, que usamos para tener consistencia con algunos términos.
74
120
121
+ * Si tienes que usar palabras en inglés debes ponerlas en *italics * (rodeadas
122
+ por asteriscos)
75
123
124
+ * Puedes revisar las :doc: `faq ` para leer sobre problemas conocidos.
76
125
77
- .. note ::
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.
78
129
79
- También puedes unirte a `nuestro canal de Telegram `_ si necesitas ayuda.
130
+ * Tenemos una `Memoria de Traducción `_, que usamos para tener consistencia con
131
+ algunos términos.
80
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.
81
137
138
+ * Puedes usar `la traducción al Portugués `_ para ver cómo ellos hicieron la
139
+ traducción de alguna palabra.
82
140
83
- Previsualizar los cambios
84
- -------------------------
85
-
86
- Hay dos formas de visualizar, junto con el resultado final de la documentación, los cambios que has hecho.
141
+ * Wikipedia puede ser útil también. Busca la palabra en Inglés, y luego mira si
142
+ tiene una traducción al Español en la barra de la izquierda. Suelen estar
143
+ bastante bien explicados.
144
+
145
+ * Te recomendamos abrir una Pull Request aunque sea en formato borrador (marcada
146
+ como draft) desde los primeros commits de la traducción de tu fichero. De esta
147
+ forma, puedes recibir feedback desde el principio que puedes aplicar al resto
148
+ de la traducción, y probar el build más a menudo.
87
149
88
- Read the Docs
89
- `````````````
90
150
91
- Una vez que hayas hecho un Pull Request en GitHub, este mostrará al final de página una sección de "check".
92
- Ahí, debería haber uno que diga ``docs/readthedocs.org:python-docs-es ``, y al lado un link de "Details".
93
- Haciendo click en ese link, deberías poder ver una versión de la documentación con tus cambios.
151
+ .. note ::
94
152
95
- Construcción local
96
- ``````````````````
153
+ También puedes unirte a `nuestro canal de Telegram `_ si necesitas ayuda.
97
154
98
- Desde el mismo directorio ``python-docs-es/ `` que se creó cuando hiciste ``git clone ``, puedes ejecutar::
99
155
100
- make build
156
+ Previsualizar los cambios
157
+ -------------------------
101
158
102
- Este comando demorará unos minutos y generará toda la documentación en formato HTML en tu computadora .
103
- Puedes ver el con tu navegador de internet (Firefox, Chrome, etc) ejecutando::
159
+ Una vez que hayas hecho un * Pull Request * en GitHub, este mostrará al final de página una sección de "check" .
160
+ Allí debería haber uno que diga `` docs/readthedocs.org:python-docs-es `` y al lado un link de "Details".
104
161
105
- make serve
162
+ .. figure :: readthedocs-preview.png
163
+ :width: 85%
164
+ :align: center
106
165
107
- Y luego accediendo a http://localhost:8000/
166
+ Haciendo click en ese link verás una versión de la documentación completa que incluirá todos tus cambios.
167
+ Tendrás que navegar hasta el archivo que hayas cambiado para ver cómo se visualiza luego del build.
108
168
109
169
110
- .. _repositorio : https://github.com/PyCampES/python-docs-es
111
- .. _ayuda oficial de GitHub : https://help.github.com/es/github/getting-started-with-github/fork-a-repo
112
- .. _ayuda oficial de GitHub para crear un Pull Request : https://help.github.com/es/github/collaborating-with-issues-and-pull-requests/about-pull-requests
170
+ .. _repositorio : https://github.com/python/python-docs-es
171
+ .. _ayuda oficial de GitHub :
172
+ https://help.github.com/es/github/getting-started-with-github/fork-a-repo
173
+ .. _ayuda oficial de GitHub para crear un Pull Request :
174
+ https://help.github.com/es/github/collaborating-with-issues-and-pull-requests/about-pull-requests
113
175
.. _poedit : https://poedit.net/
114
176
115
177
.. _nuestro canal de Telegram : https://t.me/python_docs_es
116
- .. _Memoria de traducción : https://python-docs-es.readthedocs.io/es/3.7/translation-memory.html
117
- .. _lista de issues en GitHub : https://github.com/PyCampES/python-docs-es/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc
178
+ .. _Memoria de traducción :
179
+ https://python-docs-es.readthedocs.io/page/translation-memory.html
180
+ .. _la traducción al Portugués : https://docs.python.org/pt-br/3/
181
+ .. _lista de issues en GitHub :
182
+ https://github.com/python/python-docs-es/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+no%3Aassignee+translate
0 commit comments