1
1
:orphan:
2
2
3
- Guía para contribuir en la traducción
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
+
42
+ - Último pero no menos importante, divertite y contá con la ayuda de todes. Te
43
+ esperamos en nuestro chat en telegram. Gracias!
44
+
8
45
9
46
.. note ::
10
47
@@ -29,101 +66,117 @@ Necesitamos *mucho* de tu ayuda para poder seguir adelante con este proyecto.
29
66
30
67
git remote add upstream https://github.com/python/python-docs-es.git
31
68
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::
69
+ #. Crea una rama nueva en base al artículo en el que vayas a trabajar. Por
70
+ ejemplo, si vas a trabajar en el archivo ``glosario.po ``, usa un nombre
71
+ similar a::
34
72
35
73
git checkout -b traduccion-glosario
36
74
37
- #. Una vez que hayas elegido el archivo, lo puedes abrir con el editor poedit _ y empezar a traducir.
75
+ #. Una vez que hayas elegido el archivo, lo puedes abrir con el editor poedit _ y
76
+ empezar a traducir.
38
77
39
- #. Cuando hayas terminado tu sesión, debes guardar tus cambios y enviarlos a GitHub de nuevo::
78
+ #. Cuando hayas terminado tu sesión, debes guardar tus cambios y enviarlos a
79
+ GitHub de nuevo::
40
80
41
- git commit -am 'Traducido archivo {nombre de archivo}'
42
- git push origin traduccion-glosario
81
+ git commit -am 'Traducido archivo {nombre de archivo}' git push origin
82
+ traduccion-glosario
43
83
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.
84
+ #. No olvides añadir tu nombre al archivo ``TRANSLATORS `` si no lo has hecho
85
+ todavía. Los nombres se encuentran ordenados alfabéticamente por apellido.
46
86
47
87
#. Luego ve a tu página de GitHub y propone hacer un *Pull Request *.
48
88
49
89
.. note ::
50
90
51
- Puedes consultar la `ayuda oficial de GitHub para crear un Pull Request `_ si lo deseas.
91
+ Puedes consultar la `ayuda oficial de GitHub para crear un Pull Request `_
92
+ si lo deseas.
52
93
53
94
#. En la descripción de la *Pull Request * escribe ``Closes #<número de issue> ``
54
95
(así se cierra automáticamente cuando se hace *merge *)
55
96
56
97
57
- ¿Qué archivo traducir?
98
+ ¿Qué archivo traducir?
58
99
----------------------
59
100
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:
101
+ Tenemos una `lista de issues en GitHub `_ en dónde vamos coordinando el trabajo
102
+ realizado para no traducir dos veces lo mismo. El proceso para traducir un
103
+ archivo es el siguiente:
62
104
63
105
64
- #. Elige cualquier de los que *no están asignados * a otra persona.
65
- #. Deja un comentario en el issue diciendo que quieres trabajar en él.
66
- #. Espera a que un administrador te asigne el issue.
67
- #. ¡Empieza a traducir!
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!
68
109
69
110
70
111
71
- A tener en cuenta
112
+ A tener en cuenta
72
113
-----------------
73
114
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
- * Puedes revisar las :doc: `faq ` para leer sobre problemas conocidos.
77
- * Si traduces un título que es un link, por favor traduce el link también (por ejemplo un artículo a Wikipedia).
78
- En caso de que no haya una traducción del artículo en Wikipedia deja el título sin traducir.
79
- * Tenemos una `Memoria de Traducción `_, que usamos para tener consistencia con algunos términos.
80
- * Si tienes una duda sobre una palabra o término, escríbelo como mejor suene para vos y
81
- marca ese párrafo como "Need work" / "Necesita trabajo" en *poedit *.
82
- Además, escribe un comentario explicando cuál es el termino en ese párrafo con el que no estabas segura.
83
- * Puedes usar `la traducción al Portugués `_ para ver cómo ellos hicieron la traducción de alguna palabra.
84
- * Wikipedia puede ser útil también. Busca la palabra en Inglés, y luego mira si tiene una traducción
85
- al Español en la barra de la izquierda. Suelen estar bastante bien explicados.
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
128
+ tiene una traducción al Español en la barra de la izquierda. Suelen estar
129
+ bastante bien explicados.
86
130
87
131
88
132
.. note ::
89
133
90
134
También puedes unirte a `nuestro canal de Telegram `_ si necesitas ayuda.
91
135
92
136
93
- Previsualizar los cambios
137
+ Previsualizar los cambios
94
138
-------------------------
95
139
96
- Hay dos formas de visualizar, junto con el resultado final de la documentación, los cambios que has hecho.
140
+ Hay dos formas de visualizar, junto con el resultado final de la documentación,
141
+ los cambios que has hecho.
97
142
98
- Read the Docs
143
+ Read the Docs
99
144
`````````````
100
145
101
- Una vez que hayas hecho un Pull Request en GitHub, este mostrará al final de página una sección de "check".
102
- Allí debería haber uno que diga ``docs/readthedocs.org:python-docs-es `` y al lado un link de "Details".
146
+ Una vez que hayas hecho un Pull Request en GitHub, este mostrará al final de
147
+ página una sección de "check". Allí debería haber uno que diga
148
+ ``docs/readthedocs.org:python-docs-es `` y al lado un link de "Details".
103
149
104
- Haciendo click en ese link verás una versión de la documentación con tus cambios.
150
+ Haciendo click en ese link verás una versión de la documentación con tus
151
+ cambios.
105
152
106
- Construcción local
153
+ Construcción local
107
154
``````````````````
108
155
109
- Desde el mismo directorio ``python-docs-es/ `` que se creó cuando hiciste ``git clone `` puedes ejecutar::
156
+ Desde el mismo directorio ``python-docs-es/ `` que se creó cuando hiciste ``git
157
+ clone `` puedes ejecutar::
110
158
111
159
make build
112
160
113
- Este comando demorará unos minutos y generará toda la documentación en formato HTML en tu computadora.
114
- Puedes ver el resultado con tu navegador de internet (Firefox, Chrome, etc) ejecutando::
161
+ Este comando demorará unos minutos y generará toda la documentación en formato
162
+ HTML en tu computadora. Puedes ver el resultado con tu navegador de internet
163
+ (Firefox, Chrome, etc) ejecutando::
115
164
116
165
make serve
117
166
118
167
Y luego accediendo a http://localhost:8000/
119
168
120
169
121
170
.. _repositorio : https://github.com/python/python-docs-es
122
- .. _ayuda oficial de GitHub : https://help.github.com/es/github/getting-started-with-github/fork-a-repo
123
- .. _ayuda oficial de GitHub para crear un Pull Request : https://help.github.com/es/github/collaborating-with-issues-and-pull-requests/about-pull-requests
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
124
175
.. _poedit : https://poedit.net/
125
176
126
177
.. _nuestro canal de Telegram : https://t.me/python_docs_es
127
- .. _Memoria de traducción : https://python-docs-es.readthedocs.io/page/translation-memory.html
178
+ .. _Memoria de traducción :
179
+ https://python-docs-es.readthedocs.io/page/translation-memory.html
128
180
.. _la traducción al Portugués : https://docs.python.org/pt-br/3/
129
- .. _lista de issues en GitHub : https://github.com/python/python-docs-es/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc
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