Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
140 lines (92 loc) · 3.95 KB

CONTRIBUTING.md

File metadata and controls

140 lines (92 loc) · 3.95 KB

Hacktoberfest 2021!

Guia de participacion.

Muchas gracias por apoyar este repositorio dentro de Hacktoberfest 2021. Tenemos varios issues listos para este evento.

Queremos migrar los metadatos y fotos de articulos de formato antiguo (ruby) a formato compatible con pelican.

Antes de participar, recuerda registrarte en la siguiente pagina para que tus PR sean validas.

  • Sigue esta PR como ejemplo

  • Un ejemplo de migrar metadatos:

- Version anterior

Invitación a reunión abril 2020
==================================

Fecha: 2020-04-11 14:00
Autor:  Chico
Categorías: Junta Ordinaria

- Compatible con pelican

# Invitación a reunión abril 2020

date: 2020-04-11 14:00
author:  Chico
category: Junta Ordinaria
  • Un ejemplo de migrar fotos
<!-- Version anterior -->
<center>
<a class="img-responsive" href="2020-04-11-invitacion-reunion-abril/chat.png"><img class="img-responsive" style="width:60%;height:auto;margin-right:12px;" src="2020-04-11-invitacion-reunion-abril/chat.png" alt="VideoConferencia abril" width="325" height="250"></a>
</center>

<!-- Compatible con pelican | agregar {attach} a href y a src -->
<center>
<a class="img-responsive" href="{attach}2020-04-11-invitacion-reunion-abril/chat.png"><img class="img-responsive" style="width:60%;height:auto;margin-right:12px;" src="{attach}2020-04-11-invitacion-reunion-abril/chat.png" alt="VideoConferencia abril" width="325" height="250"></a>
</center>

Prerequisitos

  1. Tener git instalado y cuenta de github.
  2. Editor de texto favorito.
  3. Python 3.14+ instalado.
  4. uv instalado.

Sigue estos pasos para aportar a este repositorio.

  1. Deja un comentario dentro del issue en el que quieres participar. La prioridad son los llamados Migracion.
  2. Clona el repositorio.
# ssh clone - si tienes habilitado verificacion en dos pasos
git clone git@github.com:GULAG/gulag.github.io.git

# http clone
git clone https://github.com/GULAG/gulag.github.io.git
  1. Entra al folder gulag.github.io
cd gulag.github.io
  1. Instalar las librerias
uv sync --frozen
  1. Crea un branch con el numero del issue.
git checkout -b issue_<numero de issue>/migracion_<numero de migracion>  

# Ejemplo con issue 9, migracion 1
git checkout -b issue_09/migracion_01

  1. Haz los cambios mencionados en el issue que escogiste.

  2. Para probar tus cambios corre los siguientes comandos.

# construir el sitio
uv run pelican content -o output -s pelicanconf.py

# correr el sitio en server local
uv run pelican -l -r

# presiona ctrl+c para salir del server local
  1. Ya que esten listos es hora de hacer tu Pull Request (PR). Corre los siguientes comandos para publicar tu branch con tus cambios en Github.
git add .
git commit -m 'Mensage concreto de tus cambios'
git push --set-upstream origin issue_<numero de issue>/migracion_<numero de migracion>

  1. Ahora visita el repositorio en github.com

  2. Tu branch debera aparecer junto a un boton que diga comparar y crear PR o compare and create PR. Dale click.

  3. En la siguiente pagina llena el titulo con el numero de issue y nombre.

  • Ejemplo:
Title: Issue 9 | Migracion 01

  1. En el cuerpo de la PR explica los cambios que realizaste.

  2. No olvides agregar el numero de issue en el cuerpo de la PR.

  • Ejemplo:
#9

  1. Esto ligara tu PR con el issue.

  2. Agrega el label / etiqueta de hacktoberfest a tu PR para que cuente. En reviewers agrega a GULAG/Publicadores

  3. Dale click al boton crear PR / Create PR. Eso lanzara el proceso de CI del sitio. Si pasa los checks, felicidades! Tu PR estara lista para hacer merge. Espera la revision de alguien del equipo.

  4. Si no paso el check de CI. No te preocupes. Revisa el log y trata de nuevo. Manda un comentario y te ayudaremos.