@@ -4,54 +4,28 @@ Guía para contribuir en la traducción
4
4
=====================================
5
5
6
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.
7
+ documentación oficial de Python al Español!
10
8
11
9
Este es el grupo de trabajo para la traducción de la
12
10
documentación oficial de Python al Español, todo el contenido de la traducción
13
11
es mantenido por voluntaries que aportan su tiempo y trabajo a la comunidad.
14
12
15
13
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
-
14
+ contribución, queremos señalar algunos
15
+ :ref: `lineamientos generales <a-tener-en-cuenta >`.
45
16
46
17
.. note ::
47
18
48
19
Si tienes cualquier duda, puedes enviarnos un email a docs-es@python.org.
49
20
21
+ Antes de comenzar
22
+ -----------------
50
23
51
- ¡Comienza a traducir!
52
- ---------------------
24
+ #. Para enviar una traducción, necesitas tener un ** fork ** del repositorio _
25
+ oficial, haciendo click en el botón encerrado en rojo.
53
26
54
- #. Crea un fork del repositorio _.
27
+ .. image :: fork.png
28
+ :alt: botón fork
55
29
56
30
.. note ::
57
31
@@ -69,8 +43,35 @@ contribución, queremos señalar algunos lineamientos generales.
69
43
70
44
git remote add upstream https://github.com/python/python-docs-es.git
71
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::
57
+
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
+
72
73
#. 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
+ ejemplo, si vas a trabajar en el archivo ``library/ glosario.po ``, usa un nombre
74
75
similar a::
75
76
76
77
git checkout -b traduccion-glosario
@@ -79,29 +80,31 @@ contribución, queremos señalar algunos lineamientos generales.
79
80
empezar a traducir.
80
81
81
82
#. Cuando hayas terminado tu sesión, debes guardar tus cambios y enviarlos a
82
- GitHub de nuevo::
83
-
84
- git commit -am 'Traducido archivo {nombre de archivo}' git push origin
85
- traduccion-glosario
86
-
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.
83
+ GitHub (No olvides añadir tu nombre al archivo ``TRANSLATORS ``)::
89
84
90
- #. Luego ve a tu página de GitHub y propone hacer un *Pull Request *.
85
+ git add library/glosario.po
86
+ git commit -m 'Traducido archivo library/glosario'
87
+ git push origin traduccion-glosario
91
88
92
89
.. note ::
93
90
91
+ Mira los mensajes que el último comando imprimirá por pantalla,
92
+ pues encontrarás un enlace para abrir un nuevo Pull-request directamente.
93
+
94
94
Puedes consultar la `ayuda oficial de GitHub para crear un Pull Request `_
95
95
si lo deseas.
96
96
97
+
97
98
#. En la descripción de la *Pull Request * escribe ``Closes #<número de issue> ``
98
99
(así se cierra automáticamente cuando se hace *merge *)
99
100
100
101
.. note ::
101
102
102
103
Si hace tiempo que venis trabajando en una traducción es importante
103
- mantener actualizada tu copia local antes de realizar el *Pull Request* *
104
+ :ref: `mantener actualizada <mantener-actualizada >` tu copia local antes
105
+ de realizar el *Pull Request *.
104
106
107
+ .. _que-archivo-traducir :
105
108
106
109
¿Qué archivo traducir?
107
110
----------------------
@@ -117,25 +120,51 @@ archivo es el siguiente:
117
120
#. ¡Empieza a traducir!
118
121
119
122
123
+ .. _a-tener-en-cuenta :
120
124
121
125
A tener en cuenta
122
126
-----------------
123
127
124
- * No debes traducir el contenido de ``:ref:... `` y ``:term:... ``.
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).
136
+
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).
141
+
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.
125
144
126
- * Si tienes que usar palabras en inglés debes ponerlas en *italics * (rodeadas
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 >`)
148
+
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.
152
+
153
+ * **No debes ** traducir el contenido de ``:ref:... ``, ``:term:... ``, ``:dfn:... ``, etc.
154
+
155
+ * Si tienes que usar palabras en inglés debes ponerlas en *cursiva * (rodeadas
127
156
por asteriscos)
128
157
129
- * Puedes revisar las :doc: `faq ` para leer sobre problemas conocidos.
158
+ * Puedes revisar las :doc: `Preguntas Frecuentes < faq > ` para leer sobre problemas conocidos.
130
159
131
- * Si traduces un título que es un link , por favor traduce el link también (por
160
+ * Si ** traduces un título que es un enlace ** , por favor traduce el link también (por
132
161
ejemplo un artículo a Wikipedia). En caso de que no haya una traducción del
133
162
artículo en Wikipedia deja el título sin traducir.
134
163
135
- * Tenemos una `Memoria de Traducción `_ , que usamos para tener consistencia con
136
- algunos términos.
164
+ * Tenemos una :doc: `Memoria de Traducción < translation-memory >` , que usamos para tener
165
+ consistencia con algunos términos.
137
166
138
- * Si tienes una duda sobre una palabra o término, escríbelo como mejor suene
167
+ * Si tienes una ** duda sobre una palabra o término ** , escríbelo como mejor suene
139
168
para vos y marca ese párrafo como "Need work" / "Necesita trabajo" en
140
169
*poedit *. Además, escribe un comentario explicando cuál es el termino en ese
141
170
párrafo con el que no estabas segura.
@@ -146,12 +175,15 @@ A tener en cuenta
146
175
* Wikipedia puede ser útil también. Busca la palabra en Inglés, y luego mira si
147
176
tiene una traducción al Español en la barra de la izquierda. Suelen estar
148
177
bastante bien explicados.
149
-
150
- * Te recomendamos abrir una Pull Request aunque sea en formato borrador (marcada
178
+
179
+ * Te recomendamos abrir una ** Pull Request aunque sea en formato borrador ** (marcada
151
180
como draft) desde los primeros commits de la traducción de tu fichero. De esta
152
181
forma, puedes recibir feedback desde el principio que puedes aplicar al resto
153
182
de la traducción, y probar el build más a menudo.
154
183
184
+ * Último pero no menos importante, **divertite y contá con la ayuda de todes **. Te
185
+ esperamos en nuestro chat en telegram. ¡Gracias!
186
+
155
187
156
188
.. note ::
157
189
@@ -180,8 +212,6 @@ Tendrás que navegar hasta el archivo que hayas cambiado para ver cómo se visua
180
212
.. _poedit : https://poedit.net/
181
213
182
214
.. _nuestro canal de Telegram : https://t.me/python_docs_es
183
- .. _Memoria de traducción :
184
- https://python-docs-es.readthedocs.io/page/translation-memory.html
185
215
.. _la traducción al Portugués : https://docs.python.org/pt-br/3/
186
216
.. _lista de issues en GitHub :
187
217
https://github.com/python/python-docs-es/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+no%3Aassignee+translate
0 commit comments