Contributing
Autor: Afaces
Contribuyendo a MiRabbitOSr1.github.io
¡Nos alegra que quieras contribuir al proyecto MiRabbitOSr1! Colaborar nos ayuda a mejorar los recursos y la información disponible para la comunidad de Rabbit R1. Esta guía te ayudará a entender cómo contribuir de manera efectiva.
Tabla de Contenidos
- Introducción
- Cómo Crear y Enviar Pull Requests
- Crear Nuevos Archivos
- Flujo de Trabajo Clásico de GitHub
- Abrir Problemas (Issues)
- Contacto
Introducción
- Haz un Fork del Repositorio: Haz clic en el botón ‘Fork’ en la parte superior derecha de la página del repositorio para crear tu propia copia del repositorio.
- Enlace al repositorio en GitHub ➡ MiRabbitOSr1.github.io
- Clona el Repositorio Forkeado: Clona tu fork en tu máquina local usando el comando:
git clone https://github.com/tu-usuario/MiRabbitOSr1.github.io.git
- Navega al Directorio: Cambia al directorio del repositorio:
cd MiRabbitOSr1.github.io
Cómo Crear y Enviar Pull Requests
🟠 Guía Paso a Paso para Pull Requests
- Crea una Nueva Rama: Es importante crear una nueva rama para cada característica o corrección en la que trabajes. Esto mantiene tu rama principal limpia.
git checkout -b nombre-de-tu-rama
- Haz Tus Cambios: Agrega o modifica archivos en el repositorio.
- Añade los Cambios al Área de Staging: Una vez que hayas hecho tus cambios, agrégales al área de staging:
git add .
- Haz un Commit de Tus Cambios: Comenta tus cambios con un mensaje descriptivo:
git commit -m "Descripción breve de los cambios"
- Sube los Cambios a GitHub: Sube tus cambios a tu repositorio forked:
git push origin nombre-de-tu-rama
- Crea un Pull Request: Ve al repositorio original y verás un aviso para crear un pull request desde tu nueva rama. Sigue las instrucciones para abrir un pull request.
🟠 Nombrar Nuevos Archivos
Cuando crees nuevos archivos, usa la siguiente convención de nombres para incluir la fecha y un título descriptivo:
YYYY-MM-DD-Titulo-de-Tu-Artículo.md
Ejemplo:
2024-07-20-Actualizaciones-y-mejoras-de-software-en-Rabbit-R1.md
⚠️ Guarda estos archivos en la carpeta _posts
dentro del repositorio para que se integren correctamente con el sitio web. ⚠️
Flujo de Trabajo Clásico de GitHub
- Haz un Fork del Repositorio: Esto crea una copia del repositorio bajo tu cuenta de GitHub.
- Clona el Repositorio: Descarga el repositorio en tu máquina local.
- Crea una Rama: Siempre crea una nueva rama para trabajar en una característica específica o una corrección.
- Haz Cambios: Agrega, modifica o elimina archivos según sea necesario.
- Haz un Commit de los Cambios: Realiza un commit con un mensaje claro y conciso.
- Sube los Cambios: Sube tus cambios a tu repositorio forked.
- Crea un Pull Request: Envía un pull request al repositorio original para revisión.
Abrir Problemas (Issues)
Si encuentras errores o tienes sugerencias para nuevas características, puedes abrir un problema. Aquí te explicamos cómo:
- Navega a la Pestaña de Problemas: Ve a la pestaña Issues en el repositorio.
- Haz Clic en Nuevo Problema: Haz clic en el botón ‘New Issue’.
- Completa la Plantilla del Problema: Proporciona una descripción clara y concisa del problema o sugerencia. Si es un error, incluye pasos para reproducirlo, el comportamiento esperado y capturas de pantalla si es aplicable.
- Envía el Problema: Haz clic en ‘Submit new issue’ para crear el problema.