Skip to content

Commit 6c68ae3

Browse files
committed
Update contributing with new information about issues triagging
1 parent 81f6abb commit 6c68ae3

File tree

2 files changed

+62
-306
lines changed

2 files changed

+62
-306
lines changed

.overrides/CONTRIBUTING.rst

+48-31
Original file line numberDiff line numberDiff line change
@@ -4,79 +4,98 @@ Guía para contribuir en la traducción
44
¡Muchas gracias por tu interés en participar de la traducción de la documentación oficial de Python al Español!
55
Necesitamos *mucho* de tu ayuda para poder seguir adelante con este proyecto.
66

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-
127
.. note::
138

149
Si tienes cualquier duda, puedes enviarnos un email a docs-es@python.org.
1510

1611

17-
Desde GitHub
18-
------------
19-
2012
#. Crea un fork del repositorio_.
2113

2214
.. note::
2315

2416
Puedes consular la `ayuda oficial de GitHub`_, si lo deseas.
2517

26-
#. Clona el repositorio::
18+
#. Clona el fork del repositorio que acabas de crear::
2719

28-
git clone git@github.com:<TU-USUARIO>/python-docs-es.git
20+
git clone git@github.com:<TU-USUARIO>/python-docs-es.git
2921

3022
#. Ingresa en la carpeta que `git clone` creó en tu computadora::
3123

32-
cd python-docs-es/
24+
cd python-docs-es/
3325

3426
#. Agrega el repositorio original como "upstream"::
3527

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
3729

3830
#. 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::
3932

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
4634

4735
#. Una vez que hayas elegido el archivo, lo puedes abrir con el editor poedit_ y empezar a traducir.
4836

4937
#. Cuando hayas terminado tu sesión, debes guardar tus cambios y enviarlos a GitHub de nuevo::
5038

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
5341

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.
5543
Los nombres se encuentran ordenados alfabéticamente por apellido.
5644

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.
5846

5947
.. note::
6048

6149
Puedes consultar la `ayuda oficial de GitHub para crear un Pull Request`_ si lo deseas.
6250

6351

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+
6483
Previsualizar los cambios
65-
~~~~~~~~~~~~~~~~~~~~~~~~~
84+
-------------------------
6685

6786
Hay dos formas de visualizar, junto con el resultado final de la documentación, los cambios que has hecho.
6887

6988
Read the Docs
7089
`````````````
7190

7291
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".
7493
Haciendo click en ese link, deberías poder ver una versión de la documentación con tus cambios.
7594

7695
Construcción local
7796
``````````````````
7897

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::
8099

81100
make build
82101

@@ -88,13 +107,11 @@ Puedes ver el con tu navegador de internet (Firefox, Chrome, etc) ejecutando::
88107
Y luego accediendo a http://localhost:8000/
89108

90109

91-
Utilizando Transifex
92-
--------------------
93-
94-
ToDo.
95-
96-
97110
.. _repositorio: https://github.com/PyCampES/python-docs-es
98111
.. _ayuda oficial de GitHub: https://help.github.com/es/github/getting-started-with-github/fork-a-repo
99112
.. _ayuda oficial de GitHub para crear un Pull Request: https://help.github.com/es/github/collaborating-with-issues-and-pull-requests/about-pull-requests
100113
.. _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

Comments
 (0)