Skip to content

Commit 57506f7

Browse files
committed
fix: contributing guide
1 parent 1708911 commit 57506f7

File tree

1 file changed

+20
-9
lines changed

1 file changed

+20
-9
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,11 @@ git clone https://github.com/<user-github>/blogpythonchile.git
4343

4444
### 3. Crear una rama para post
4545

46+
Nomenclatura debe ser `feature-<titulo>` donde `feature` indica que se agrega nuevo contenido (para correciones se ocupa prefijo `fix`)
47+
y `<titulo>` indica el nombre del post, cuyo valor depende de quién contribuya.
48+
4649
```bash
47-
git checkout -b mi-primer-post
50+
git checkout -b feature-hello-world
4851
```
4952

5053
### 4. Agregar post
@@ -71,7 +74,9 @@ publishconf.py # Configuración para ambiente de producción
7174

7275
# 3. 📝 Crear un Post
7376

74-
### 1. Crear un nuevo archivo **Markdown** en `content/post` con el formato `AAAA-MM-DD-titulo-mi-post.md`
77+
### 1. Nuevo archivo
78+
79+
Crear archivo **Markdown** (extensión `.md`) en ruta `content/post/` con el formato `AAAA-MM-DD-titulo-mi-post.md`.
7580

7681
Ejemplo:
7782

@@ -82,9 +87,11 @@ content/post/2025-08-25-hello-world.md
8287
>[!WARNING]
8388
> Favor respetar formato fecha
8489
85-
### 2. Agregar la metadata al principio del archivo
90+
### 2. Agregar metadata
91+
92+
Se debe agregar **metada** al inicio del archivo **Markdown** ya que esta se ocupan como variables para crear contenido.
8693

87-
Seguir siguiente formato
94+
Seguir siguiente formato:
8895

8996
```bash
9097
---
@@ -100,7 +107,7 @@ Contenido del post comienza aquí...
100107
```
101108

102109
>[!WARNING]
103-
> Toda metadata es obligatoria como también el formato de esta.
110+
> Toda metadata es obligatoria como también el formato y orden de esta.
104111
105112
Descripción de metada:
106113

@@ -122,7 +129,7 @@ se puede comenzar a escribir el contenido del post.
122129

123130
### 1. Texto
124131

125-
Solamente usar formato de **Markdown**.
132+
Usar formato de **Markdown** para crear el cuerpo del post.
126133

127134
### 2. Bloque de código
128135

@@ -139,7 +146,11 @@ Para mostrar código seguir el siguiente formato:
139146
texto ...
140147
```
141148

149+
>[!NOTE]
150+
> Por defecto todo bloque de código tiene botón de copiar código.
151+
142152
El bloque de código debe situarse en la **columna 0**, es decir, no se le debe aplicar ningún tab.
153+
143154
Al momento de crear el sitio estático, todo bloque de código estará centrado horizontalmente
144155

145156
Es importante también agregar un espacio en blanco antes y después del bloque de código.
@@ -167,7 +178,7 @@ crear en el momento de la contribución del post.
167178

168179
### 1. Versión de Python
169180

170-
Ocupar versión que sea igual o mayor a 3.11
181+
Ocupar versión que sea igual o mayor a versión 3.11
171182

172183
### 2. Instalación de dependencias
173184

@@ -198,7 +209,7 @@ para generar el sitio estático en la carpeta **output/**
198209

199210
### 4. Prevista en local
200211

201-
URL de sitio `http://localhost:800`
212+
URL de sitio `http://localhost:8000`
202213

203214
```bash
204215
pelican -l
@@ -221,7 +232,7 @@ Considerar los siguientes puntos para la revisión:
221232
# 7. ⭐ ¿Primera contribución al blog?
222233

223234
Si es el primer aporte por favor considerar agregar algunos datos del perfil de github para poder mostrarlo junto al resto
224-
de contribuidores
235+
de contribuidores.
225236

226237
En archivo `contributors.py` agregar los siguientes valores llave-valor siguiendo formato **json**:
227238

0 commit comments

Comments
 (0)