@@ -4,79 +4,98 @@ Guía para contribuir en la traducción
4
4
¡Muchas gracias por tu interés en participar de la traducción de la documentación oficial de Python al Español!
5
5
Necesitamos *mucho * de tu ayuda para poder seguir adelante con este proyecto.
6
6
7
- Actualmente se puede colaborar utilizando una de las dos siguientes formas que:
8
-
9
- #. Utilizando el repositorio de GitHub y el editor poedit _
10
- #. Realizando traducciones directamente en Transifex
11
-
12
7
.. note ::
13
8
14
9
Si tienes cualquier duda, puedes enviarnos un email a docs-es@python.org.
15
10
16
11
17
- Desde GitHub
18
- ------------
19
-
20
12
#. Crea un fork del repositorio _.
21
13
22
14
.. note ::
23
15
24
16
Puedes consular la `ayuda oficial de GitHub `_, si lo deseas.
25
17
26
- #. Clona el repositorio::
18
+ #. Clona el fork del repositorio que acabas de crear ::
27
19
28
- git clone git@github.com:<TU-USUARIO>/python-docs-es.git
20
+ git clone git@github.com:<TU-USUARIO>/python-docs-es.git
29
21
30
22
#. Ingresa en la carpeta que `git clone ` creó en tu computadora::
31
23
32
- cd python-docs-es/
24
+ cd python-docs-es/
33
25
34
26
#. Agrega el repositorio original como "upstream"::
35
27
36
- git remote add upstream https://github.com/pycampes/python-docs-es.git
28
+ git remote add upstream https://github.com/pycampes/python-docs-es.git
37
29
38
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::
39
32
40
- git checkout -b traduccion_glosario
41
-
42
- #. Mira que archivo necesita ser traducido. El siguiente comando te mostrará una lista de archivos y los porcentajes traducidos.
43
- Elige uno que no esté completo::
44
-
45
- make progress
33
+ git checkout -b traduccion-glosario
46
34
47
35
#. Una vez que hayas elegido el archivo, lo puedes abrir con el editor poedit _ y empezar a traducir.
48
36
49
37
#. Cuando hayas terminado tu sesión, debes guardar tus cambios y enviarlos a GitHub de nuevo::
50
38
51
- git commit -am 'Traducido archivo {nombre de archivo}'
52
- git push origin traduccion_glosario
39
+ git commit -am 'Traducido archivo {nombre de archivo}'
40
+ git push origin traduccion-glosario
53
41
54
- #. No olvides añadir tu nombre al archivo TRANSLATORS si no lo has hecho todavía.
42
+ #. No olvides añadir tu nombre al archivo `` TRANSLATORS `` si no lo has hecho todavía.
55
43
Los nombres se encuentran ordenados alfabéticamente por apellido.
56
44
57
- #. Luego ve a tu página de GitHub y propone hacer un Pull Request
45
+ #. Luego ve a tu página de GitHub y propone hacer un Pull Request.
58
46
59
47
.. note ::
60
48
61
49
Puedes consultar la `ayuda oficial de GitHub para crear un Pull Request `_ si lo deseas.
62
50
63
51
52
+ ¿Qué archivo traducir?
53
+ ----------------------
54
+
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:
57
+
58
+
59
+ #. Elige cualquier de los que *no están asignados * a otra persona.
60
+ #. Deja un comentario en el issue diciendo que quieres trabajar en él.
61
+ #. Espera a que un administrador te asigne el issue.
62
+ #. ¡Empieza a traducir!
63
+
64
+
65
+
66
+ A tener en cuenta
67
+ -----------------
68
+
69
+ * 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
+
75
+
76
+
77
+ .. note ::
78
+
79
+ También puedes unirte a `nuestro canal de Telegram `_ si necesitas ayuda.
80
+
81
+
82
+
64
83
Previsualizar los cambios
65
- ~~~~~~~~~~~~~~~~~~~~~~~~~
84
+ -------------------------
66
85
67
86
Hay dos formas de visualizar, junto con el resultado final de la documentación, los cambios que has hecho.
68
87
69
88
Read the Docs
70
89
`````````````
71
90
72
91
Una vez que hayas hecho un Pull Request en GitHub, este mostrará al final de página una sección de "check".
73
- Ahí, debería haber uno que diga `docs/readthedocs.org:python-docs-es `, y al lado un link de "Details".
92
+ Ahí, debería haber uno que diga `` docs/readthedocs.org:python-docs-es ` `, y al lado un link de "Details".
74
93
Haciendo click en ese link, deberías poder ver una versión de la documentación con tus cambios.
75
94
76
95
Construcción local
77
96
``````````````````
78
97
79
- Desde el mismo directorio `python-docs-es/ ` que se creó cuando hiciste `git clone `, puedes ejecutar::
98
+ Desde el mismo directorio `` python-docs-es/ `` que se creó cuando hiciste `` git clone ` `, puedes ejecutar::
80
99
81
100
make build
82
101
@@ -88,13 +107,11 @@ Puedes ver el con tu navegador de internet (Firefox, Chrome, etc) ejecutando::
88
107
Y luego accediendo a http://localhost:8000/
89
108
90
109
91
- Utilizando Transifex
92
- --------------------
93
-
94
- ToDo.
95
-
96
-
97
110
.. _repositorio : https://github.com/PyCampES/python-docs-es
98
111
.. _ayuda oficial de GitHub : https://help.github.com/es/github/getting-started-with-github/fork-a-repo
99
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
100
113
.. _poedit : https://poedit.net/
114
+
115
+ .. _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
0 commit comments