Skip to content

Commit a1d2cee

Browse files
authored
Reestructurar página de contribución (#916)
1 parent 5c3f86f commit a1d2cee

File tree

2 files changed

+79
-50
lines changed

2 files changed

+79
-50
lines changed

.overrides/CONTRIBUTING.rst

Lines changed: 79 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -4,55 +4,28 @@ Guía para contribuir en la traducción
44
=====================================
55

66
¡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!
108

119
Este es el grupo de trabajo para la traducción de la
1210
documentación oficial de Python al Español, todo el contenido de la traducción
1311
es mantenido por voluntaries que aportan su tiempo y trabajo a la comunidad.
1412

1513
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-
14+
contribución, queremos señalar algunos
15+
:ref:`lineamientos generales <a-tener-en-cuenta>`.
4616

4717
.. note::
4818

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

21+
Antes de comenzar
22+
-----------------
5123

52-
¡Comienza a traducir!
53-
---------------------
24+
#. Para enviar una traducción, necesitas tener un **fork** del repositorio_
25+
oficial, haciendo click en el botón encerrado en rojo.
5426

55-
#. Crea un fork del repositorio_.
27+
.. image:: fork.png
28+
:alt: botón fork
5629

5730
.. note::
5831

@@ -70,8 +43,33 @@ contribución, queremos señalar algunos lineamientos generales.
7043

7144
git remote add upstream https://github.com/python/python-docs-es.git
7245

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 contruir 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**::
68+
69+
git checkout 3.8
70+
7371
#. 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
72+
ejemplo, si vas a trabajar en el archivo ``library/glosario.po``, usa un nombre
7573
similar a::
7674

7775
git checkout -b traduccion-glosario
@@ -80,29 +78,31 @@ contribución, queremos señalar algunos lineamientos generales.
8078
empezar a traducir.
8179

8280
#. Cuando hayas terminado tu sesión, debes guardar tus cambios y enviarlos a
83-
GitHub de nuevo::
81+
GitHub (No olvides añadir tu nombre al archivo ``TRANSLATORS``)::
8482

85-
git commit -am 'Traducido archivo {nombre de archivo}'
83+
git add library/glosario.po
84+
git commit -m 'Traducido archivo library/glosario'
8685
git push origin traduccion-glosario
8786

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.
90-
91-
#. Luego ve a tu página de GitHub y propone hacer un *Pull Request*.
92-
9387
.. note::
9488

89+
Mira los mensajes que el último comando imprimirá por pantalla,
90+
pues encontrarás un enlace para abrir un nuevo Pull-request directamente.
91+
9592
Puedes consultar la `ayuda oficial de GitHub para crear un Pull Request`_
9693
si lo deseas.
9794

95+
9896
#. En la descripción de la *Pull Request* escribe ``Closes #<número de issue>``
9997
(así se cierra automáticamente cuando se hace *merge*)
10098

10199
.. note::
102100

103101
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*.
102+
:ref:`mantener actualizada <mantener-actualizada>` tu copia local antes
103+
de realizar el *Pull Request*.
105104

105+
.. _que-archivo-traducir:
106106

107107
¿Qué archivo traducir?
108108
----------------------
@@ -118,25 +118,51 @@ archivo es el siguiente:
118118
#. ¡Empieza a traducir!
119119

120120

121+
.. _a-tener-en-cuenta:
121122

122123
A tener en cuenta
123124
-----------------
124125

125-
* No debes traducir el contenido de ``:ref:...`` y ``:term:...``.
126+
* Esta traducción es mantenida por **personas de todo el mundo** que hablan el
127+
idioma Español. No queremos atarla a ninguna región en particular y creemos
128+
que es un valor extra la diversidad de la misma. Vas a encontrar secciones
129+
con diferentes tonalidades de países, regiones o estilos. Lo único que pedimos
130+
es **consistencia** dentro de un mismo módulo o sección (es decir no cambiar de
131+
estilo de un párrafo a otro, por ejemplo) y siempre intentar que la persona del
132+
otro lado pueda entender lo que estamos escribiendo (no usar lunfardo o
133+
regionalismos muy propios de un único lugar).
134+
135+
* En muchos casos el **mejor criterio** es pensar en el vocabulario que utilizamos
136+
cuando le explicamos a otra persona, o en el trabajo. En muchas ocasiones la
137+
versión en inglés o “spanglish” de la palabra es mucho mejor que decir “git
138+
unir” (para git merge).
139+
140+
* Siempre vas a tener una **revisión de lo que propongas** y en ese intercambio otras
141+
personas van a ayudarte a destrabar las dudas que tengas.
142+
143+
* Colaborar **haciendo revisiones** también es muy muy importante, así que si
144+
tienes un rato libre puedes comenzar por mirar los PRs pendientes de revisar.
145+
(mira la `Guía del revisor`_)
146+
147+
* La documentación es ENORME, cualquier traba que encuentres siempre puedes
148+
marcar el texto como **"fuzzy"** o para revisar en el futuro.
149+
No pierdas horas buscando la palabra perfecta.
150+
151+
* **No debes** traducir el contenido de ``:ref:...``, ``:term:...``, ``:dfn:...``, etc.
126152

127153
* Si tienes que usar palabras en inglés debes ponerlas en *cursiva* (rodeadas
128154
por asteriscos)
129155

130-
* Puedes revisar las :doc:`faq` para leer sobre problemas conocidos.
156+
* Puedes revisar las :doc:`Preguntas Frecuentes <faq>` para leer sobre problemas conocidos.
131157

132-
* Si traduces un título que es un link, por favor traduce el link también (por
158+
* Si **traduces un título que es un enlace**, por favor traduce el link también (por
133159
ejemplo un artículo a Wikipedia). En caso de que no haya una traducción del
134160
artículo en Wikipedia deja el título sin traducir.
135161

136162
* Tenemos una `Memoria de Traducción`_, que usamos para tener consistencia con
137163
algunos términos.
138164

139-
* Si tienes una duda sobre una palabra o término, escríbelo como mejor suene
165+
* Si tienes una **duda sobre una palabra o término**, escríbelo como mejor suene
140166
para vos y marca ese párrafo como "Need work" / "Necesita trabajo" en
141167
*poedit*. Además, escribe un comentario explicando cuál es el termino en ese
142168
párrafo con el que no estabas segura.
@@ -148,11 +174,14 @@ A tener en cuenta
148174
tiene una traducción al Español en la barra de la izquierda. Suelen estar
149175
bastante bien explicados.
150176

151-
* Te recomendamos abrir una Pull Request aunque sea en formato borrador (marcada
177+
* Te recomendamos abrir una **Pull Request aunque sea en formato borrador** (marcada
152178
como draft) desde los primeros commits de la traducción de tu fichero. De esta
153179
forma, puedes recibir feedback desde el principio que puedes aplicar al resto
154180
de la traducción, y probar el build más a menudo.
155181

182+
* Último pero no menos importante, **divertite y contá con la ayuda de todes**. Te
183+
esperamos en nuestro chat en telegram. ¡Gracias!
184+
156185

157186
.. note::
158187

.overrides/fork.png

33.6 KB
Loading

0 commit comments

Comments
 (0)