Skip to content

Commit e991cb2

Browse files
committed
feat: detalle pr
1 parent 9761dbb commit e991cb2

File tree

1 file changed

+28
-17
lines changed

1 file changed

+28
-17
lines changed

CONTRIBUTING.md

Lines changed: 28 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Gracias por tu interés en contribuir al blog de la comunidad Python Chile! 🚀
44

55
El sitio está hecho con el framework [Pelican](https://getpelican.com/) y los post están escritos ocupando **Markdown**.
66

7-
Por favor sigue los siguientes puntos para contribuir con un nuevo post o para mejorar el sitio.
7+
Por favor seguir los siguientes puntos para contribuir con un nuevo post o para mejorar el sitio.
88

99
# Tabla de contenido
1010

@@ -45,7 +45,7 @@ git checkout -b mi-primer-post
4545

4646
4. Agregar post
4747

48-
Crea un archivo **Markdown** en `content/post/` y las imágenes a ocupar en `content/img/`.
48+
Crear archivo **Markdown** en `content/post/` y las imágenes a ocupar en `content/img/`.
4949

5050
Para más información dirigirse a punto **3** para crear un post y punto **4** para conocer el formato del contenido.
5151

@@ -67,7 +67,7 @@ publishconf.py # Configuración para ambiente de producción
6767

6868
# 3. 📝 Crear un Post
6969

70-
1. Crea un nuevo archivo **Markdown** en `content/post` con el formato `AAAA-MM-DD-titulo-mi-post.md`
70+
1. Crear un nuevo archivo **Markdown** en `content/post` con el formato `AAAA-MM-DD-titulo-mi-post.md`
7171

7272
Ejemplo:
7373

@@ -76,11 +76,11 @@ content/post/2025-08-25-hello-world.md
7676
```
7777

7878
>[!WARNING]
79-
> Favor de respetar formato fecha
79+
> Favor respetar formato fecha
8080
81-
2. Agrega la metadata al principio del archivo
81+
2. Agregar la metadata al principio del archivo
8282

83-
Sigue el siguiente formato
83+
Seguir siguiente formato
8484

8585
```bash
8686
---
@@ -96,7 +96,7 @@ Contenido del post comienza aquí...
9696
```
9797

9898
>[!WARNING]
99-
> Toda la metadata es obligatoria como también el formato de esta.
99+
> Toda metadata es obligatoria como también el formato de esta.
100100
101101
Descripción de metada:
102102

@@ -108,9 +108,10 @@ Descripción de metada:
108108
- **tags**: Conceptos que representen tu post. Máximo 5 y en minúsculas.
109109

110110
>[!NOTE]
111-
> Si no tienes una imagen para la prevista del post, puedes ocupar la imagen `img/otros/default.jpg`
111+
> Si no se tiene una imagen para la prevista del post, se puede ocupar la imagen `img/otros/default.jpg`
112112
113-
Luego de crear la metadata y seguido de esta un **salto de línea**, ya puedes comenzar a escribir el contenido del post.
113+
La metadata debe estar seguida de un **salto de línea**. Una vez cumplido lo anterior
114+
se puede comenzar a escribir el contenido del post.
114115

115116

116117
# 4. 🎨 Agregar Contenido de Post
@@ -134,8 +135,8 @@ Para mostrar código seguir el siguiente formato:
134135
texto ...
135136
```
136137

137-
El bloque de código debe situarse en la **columna 0**, es decir, no se le debe aplicar ni un tab.
138-
Al momento de crear el sitio estático, todo bloque de código estará situadio centrado horizontalmente
138+
El bloque de código debe situarse en la **columna 0**, es decir, no se le debe aplicar ningún tab.
139+
Al momento de crear el sitio estático, todo bloque de código estará centrado horizontalmente
139140

140141
Es importante también agregar un espacio en blanco antes y después del bloque de código.
141142

@@ -154,7 +155,7 @@ Ejemplo de imagen en un post:
154155
<img src="{static}/img/pyday/2025/copiapo/img1.webp" width="480" height="380" />
155156
```
156157

157-
Toda imagen que se ocupe en el post debe estar guarda en la ruta `content/img/<sub-carpeta>/<año>`. Si `<sub-carpeta>` y/o `<año>` no existe, se puede
158+
Toda imagen que se ocupe en el post debe estar guardada en la ruta `content/img/<sub-carpeta>/<año>`. Si `<sub-carpeta>` y/o `<año>` no existe, se puede(n)
158159
crear en el momento de la contribución del post.
159160

160161

@@ -195,13 +196,15 @@ pelican -l
195196

196197
# 6. 🔄 Pull Request Revisón
197198

198-
Cuando tengas tus cambios listos y pusheados en el fork creado anteriormente, debes abrir una pull request.
199+
Cuando los cambios estén listos y subidos en el fork creado anteriormente, se debe abrir una pull request.
199200

200-
Considerar lo siguientes puntos para la revisión:
201+
Considerar los siguientes puntos para la revisión:
201202

202-
- Tiempo es de **una semana** por motivos de disposición del equipo.
203+
- Respetar cada punto definido en la guía.
204+
- Tiempo de revisón es de **una semana** por motivos de disposición del equipo.
203205
- Considerar toda sugerencia que pueda aparecer en la revisión.
204206
- La pull request se puede rechazar si no cumple con la normativa de la comunidad.
207+
- Procurar revisar checklist al momento de abrir PR (template PR).
205208

206209
---
207210

@@ -212,7 +215,15 @@ Considerar lo siguientes puntos para la revisión:
212215
- Revisa cómo se muestra tu post en el sitio de forma local antes de la PR.
213216

214217

215-
# 💬 ¿Tienes Consultas?
218+
# 🤔 ¿Consultas?
216219

217220
En caso de cualquier duda, consulta o cualquier inconveniente, puedes escribir a la comunidad de Python Chile en
218-
el servidor oficial de Discord **Python Chile**.
221+
el servidor oficial de Discord **Python Chile**.
222+
223+
# 💬 Creación de Issue
224+
225+
Si hay algo relacionado al proyecto, ya sea algún bug, documentación, diseño de sitio, post con contenido erróneo, flujo de trabajo, o cualquier
226+
otra cosa que no sea respecto a crear un post, puedes crear un **issue** en el repositorio **blogpythonchile**, solo debes agregar la información necesaria para que
227+
cualquier persona pueda entender el contexto como también el objetivo de la issue. Una vez definido bien el detalle, ya cualquier persona se puede asignar a esta y
228+
comenzar a contribuir.
229+

0 commit comments

Comments
 (0)