3
3
Guía para contribuir en la traducción
4
4
=====================================
5
5
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! 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
+ (mira la `Guía del revisor `_)
42
+
43
+ - Último pero no menos importante, divertite y contá con la ayuda de todes. Te
44
+ esperamos en nuestro chat en telegram. ¡Gracias!
45
+
8
46
9
47
.. note ::
10
48
11
49
Si tienes cualquier duda, puedes enviarnos un email a docs-es@python.org.
12
50
13
51
52
+ ¡Comienza a traducir!
53
+ ---------------------
54
+
14
55
#. Crea un fork del repositorio _.
15
56
16
57
.. note ::
@@ -27,38 +68,48 @@ Necesitamos *mucho* de tu ayuda para poder seguir adelante con este proyecto.
27
68
28
69
#. Agrega el repositorio original como "upstream"::
29
70
30
- git remote add upstream https://github.com/pycampes /python-docs-es.git
71
+ git remote add upstream https://github.com/python /python-docs-es.git
31
72
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::
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 ``glosario.po ``, usa un nombre
75
+ similar a::
34
76
35
77
git checkout -b traduccion-glosario
36
78
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.
38
81
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 de nuevo::
40
84
41
- git commit -am 'Traducido archivo {nombre de archivo}'
42
- git push origin traduccion-glosario
85
+ git commit -am 'Traducido archivo {nombre de archivo}' git push origin
86
+ traduccion-glosario
43
87
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.
88
+ #. No olvides añadir tu nombre al archivo ``TRANSLATORS `` si no lo has hecho
89
+ todavía. Los nombres se encuentran ordenados alfabéticamente por apellido.
46
90
47
91
#. Luego ve a tu página de GitHub y propone hacer un *Pull Request *.
48
92
49
93
.. note ::
50
94
51
- Puedes consultar la `ayuda oficial de GitHub para crear un Pull Request `_ si lo deseas.
95
+ Puedes consultar la `ayuda oficial de GitHub para crear un Pull Request `_
96
+ si lo deseas.
52
97
53
98
#. En la descripción de la *Pull Request * escribe ``Closes #<número de issue> ``
54
99
(así se cierra automáticamente cuando se hace *merge *)
55
100
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 de realizar el *Pull Request *.
105
+
56
106
57
107
¿Qué archivo traducir?
58
108
----------------------
59
109
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:
110
+ Tenemos una `lista de issues en GitHub `_ en dónde vamos coordinando el trabajo
111
+ realizado para no traducir dos veces lo mismo. El proceso para traducir un
112
+ archivo es el siguiente:
62
113
63
114
64
115
#. Elige cualquier de los que *no están asignados * a otra persona.
@@ -72,57 +123,68 @@ A tener en cuenta
72
123
-----------------
73
124
74
125
* 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.
85
126
127
+ * Si tienes que usar palabras en inglés debes ponerlas en *italics * (rodeadas
128
+ por asteriscos)
86
129
87
- .. note ::
130
+ * Puedes revisar las :doc: ` faq ` para leer sobre problemas conocidos.
88
131
89
- También puedes unirte a `nuestro canal de Telegram `_ si necesitas ayuda.
132
+ * Si traduces un título que es un link, por favor traduce el link también (por
133
+ ejemplo un artículo a Wikipedia). En caso de que no haya una traducción del
134
+ artículo en Wikipedia deja el título sin traducir.
90
135
136
+ * Tenemos una `Memoria de Traducción `_, que usamos para tener consistencia con
137
+ algunos términos.
91
138
92
- Previsualizar los cambios
93
- -------------------------
139
+ * Si tienes una duda sobre una palabra o término, escríbelo como mejor suene
140
+ para vos y marca ese párrafo como "Need work" / "Necesita trabajo" en
141
+ *poedit *. Además, escribe un comentario explicando cuál es el termino en ese
142
+ párrafo con el que no estabas segura.
94
143
95
- Hay dos formas de visualizar, junto con el resultado final de la documentación, los cambios que has hecho.
144
+ * Puedes usar `la traducción al Portugués `_ para ver cómo ellos hicieron la
145
+ traducción de alguna palabra.
96
146
97
- Read the Docs
98
- `````````````
147
+ * Wikipedia puede ser útil también. Busca la palabra en Inglés, y luego mira si
148
+ tiene una traducción al Español en la barra de la izquierda. Suelen estar
149
+ bastante bien explicados.
99
150
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".
151
+ * Te recomendamos abrir una Pull Request aunque sea en formato borrador (marcada
152
+ como draft) desde los primeros commits de la traducción de tu fichero. De esta
153
+ forma, puedes recibir feedback desde el principio que puedes aplicar al resto
154
+ de la traducción, y probar el build más a menudo.
102
155
103
- Haciendo click en ese link verás una versión de la documentación con tus cambios.
104
156
105
- Construcción local
106
- ``````````````````
157
+ .. note ::
158
+
159
+ También puedes unirte a `nuestro canal de Telegram `_ si necesitas ayuda.
107
160
108
- Desde el mismo directorio ``python-docs-es/ `` que se creó cuando hiciste ``git clone `` puedes ejecutar::
109
161
110
- make build
162
+ Previsualizar los cambios
163
+ -------------------------
111
164
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::
165
+ Una vez que hayas hecho un * Pull Request * en GitHub, este mostrará al final de página una sección de "check" .
166
+ Allí debería haber uno que diga `` docs/readthedocs.org:python-docs-es `` y al lado un link de "Details".
114
167
115
- make serve
168
+ .. figure :: readthedocs-preview.png
169
+ :width: 85%
170
+ :align: center
116
171
117
- Y luego accediendo a http://localhost:8000/
172
+ Haciendo click en ese link verás una versión de la documentación completa que incluirá todos tus cambios.
173
+ Tendrás que navegar hasta el archivo que hayas cambiado para ver cómo se visualiza luego del build.
118
174
119
175
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
176
+ .. _repositorio : https://github.com/python/python-docs-es
177
+ .. _ayuda oficial de GitHub :
178
+ https://help.github.com/es/github/getting-started-with-github/fork-a-repo
179
+ .. _ayuda oficial de GitHub para crear un Pull Request :
180
+ https://help.github.com/es/github/collaborating-with-issues-and-pull-requests/about-pull-requests
123
181
.. _poedit : https://poedit.net/
124
182
125
183
.. _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
184
+ .. _Memoria de traducción :
185
+ https://python-docs-es.readthedocs.io/page/translation-memory.html
186
+ .. _Guía del revisor :
187
+ https://python-docs-es.readthedocs.io/page/reviewers-guide.html
127
188
.. _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
189
+ .. _lista de issues en GitHub :
190
+ https://github.com/python/python-docs-es/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+no%3Aassignee+translate
0 commit comments