Skip to content

Latest commit

 

History

History
50 lines (30 loc) · 4.14 KB

CONTRIBUTING.md

File metadata and controls

50 lines (30 loc) · 4.14 KB
Raw

CONTRIBUTING.md

Predicción de la Liga Profesional de Fútbol de Argentina ⚽

¡Gracias por tu interés! Este documento te guiará a través de los pasos para aportar al proyecto. Aquí tienes una guía paso a paso.

Primeros pasos 🚀

  1. Familiarízate con Astro JS: Como el proyecto utiliza este framework, es importante que conozcas los conceptos del mismo. Puedes encontrar toda la información en la documentación oficial de Astro.

  2. Configura tu entorno de desarrollo: Se recomienda utilizar pnpm como gestor de paquetes por su eficiencia y rapidez. Si no tienes pnpm instalado, puedes hacerlo ejecutando npm install -g pnpm.

Cómo contribuir 🛠

1. Configurar el entorno

  • Fork el repositorio: Haz un "fork" del proyecto a tu cuenta de GitHub para tener tu propia copia. Para hacer esto, haz clic en el botón "Fork" en la parte superior derecha de la página del repositorio en GitHub. Esto creará una copia del repositorio en tu cuenta de GitHub.

  • Clonar tu fork: Después de hacer un fork, clona el repositorio a tu máquina local. Para hacerlo, copia la URL de tu fork haciendo clic en el botón verde "Code" y luego ejecuta git clone <URL del fork> en tu terminal.

  • Añadir el repositorio original como remoto: Para mantener tu fork actualizado con los cambios del repositorio original, agrega el repositorio original como un remoto. Puedes hacerlo ejecutando git remote add upstream <URL del repositorio original>.

  • Asegurarse de usar la versión de Node correcta: Para ello, nvm use o nvm use <version>, si no usas nvm, asegúrate de descargar la versión detallada en .node-version o .nvmrc.

  • Instalar las dependencias: Navega hasta el directorio del proyecto clonado y ejecuta pnpm install para instalar todas las dependencias necesarias.

2. Trabaja en tus cambios

  • Sincroniza el fork: Puedes hacerlo desde github.com/tu-usuario/tu-repositorio-de-la-velada y haciendo click en Sync fork. También puedes hacerlo desde la terminal gh repo sync -b main o git switch main && git fetch upstream && git merge upstream/main. Más información en la documentación oficial de Github
  • Crea una nueva rama: Antes de empezar a trabajar en tus cambios, crea una nueva rama utilizando git switch -c nombre-de-tu-rama.
  • Desarrolla tus cambios: Implementa tus cambios o mejoras en tu rama local. Asegúrate de seguir las prácticas y estándares de código del proyecto.
  • Prueba tus cambios: Ejecuta pnpm run dev para iniciar el servidor de desarrollo de Astro y revisa tus cambios en el navegador.

3. Envíar tus cambios

  • Commit de tus cambios: Una vez completes tus cambio, haz commit de ellos con un mensaje claro y descriptivo.
  • Push a tu fork: Haz push de tu rama con los cambios a tu fork en GitHub utilizando git push origin nombre-de-tu-rama.
  • Crea un Pull Request (PR): En GitHub, ve a tu fork de este proyecto y haz clic en "Pull request" para iniciar uno. Asegúrate de describir claramente qué cambios has realizado y por qué son necesarios o útiles para el proyecto.

Buenas prácticas 🌟

  • Revisa los issues abiertos antes de abrir una PR, si crees que puedes solucionarlo y no hay ninguna otra PR ya abierta, usa #numero-de-la-issue en tu commit para que se añada a la issue. No está demás dejar algún comentario para que se sepa que PR está siendo usada para la issue.
  • Revisa los PRs abiertos para asegurarte de que no estás trabajando en algo que ya está en progreso. Siempre puedes ayudar en PRs ya abiertas, aportando cambios, comentarios, revisiones, etc..
  • Mantén tus commits limpios y descriptivos.
  • Sigue las convenciones de código del proyecto.
  • Actualiza tu rama con frecuencia para mantenerla al día con la rama principal del proyecto.

¿Deseas aportar algo que no es código? 🆘

Puedes abrir un issue en el repositorio para discutir tus ideas o sugerencias. ¡Toda contribución es bienvenida! También si encuentras algún error o problema, no dudes en abrir un issue.