Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
137 lines (92 loc) · 4.13 KB

CONTRIBUTING.md

File metadata and controls

137 lines (92 loc) · 4.13 KB

Guía para Colaborar

¡Gracias por su interés en contribuir a ComidaEmergencia! Hay varias formas de colaborar: reportar bugs, proponer features, trabajar en features, crear/mejorar documentación y testear.

Colaborar con código

Siga estos pasos para colaborar de manera efectiva y ordenada.

1. Haga un fork del repositorio

  • Vaya a la página principal del repositorio en GitHub.
  • Haga clic en el botón Fork (arriba a la derecha) para crear una copia en su cuenta.

2. Clone su fork

  • En su cuenta, haga clic en el botón Code y copie la URL.
  • Abra su terminal y ejecute:
  git clone https://github.com/{su-usuario}/comidaEmergencia.git
  cd comidaEmergencia

3. Cree una rama para su cambio

  • Es recomendable crear una rama específica para cada mejora o corrección:
  git checkout -b nombre-de-su-rama

4. Instale las dependencias

npm install

5. Realice sus cambios

  • Realice los cambios necesarios en el código.
  • Asegúrese de seguir las buenas prácticas y el estilo del proyecto.
  • Si agrega nuevas funcionalidades, incluya documentación y/o ejemplos.

6. Pruebe su código

  • Ejecute la app localmente:
  npm run dev
  • Verifique que su cambio funciona y no rompe nada existente.
  • No olvide ejecutar npm run lint para verificar el estilo del código.
  • No olvide ejecutar npm run prettierCheck (y npm run prettierFix de ser necesario) para verificar el formato del código.
  • No olvide ejecutar npm run test para verificar que las pruebas pasen.
  • No olvide ejecutar npm run prettierCheck y npm run prettierFix para verificar y corregir el formato del código.
  • Si el proyecto está desplegado en Vercel(recomendado), ejecute:
vercel dev

7. Haga commit y push

  • Añada sus cambios y escriba un mensaje de commit claro:
  git add .
  git commit -m "Descripción clara de su cambio"
  git push origin nombre-de-su-rama

Tip

Si usa la interfaz de VS Code para hacer el commit en la rama main, escriba ccm y presione ctrl + barra de espacio, esto generará una plantilla con la convención de commit.

8. Abra un Pull Request

8.1 Desde la línea de comandos

  git checkout main
  git pull upstream main
  git checkout nombre-de-su-rama
  git rebase main

Important

Antes de abrir un PR asegúrese de abrir un issue relacionado, si no existe uno. No se aceptarán PRs sin un issue asociado.

8.2 Desde la página de GitHub

  1. Ingrese a la página principal del repositorio en GitHub.
  2. Verá una notificación que le sugiere crear un Pull Request para su rama recién subida.
  3. Haga clic en el botón Compare & pull request o en la pestaña Pull requests y luego en New pull request.
  4. Seleccione su rama como "compare" y la rama main como "base".
  5. Complete la plantilla de Pull Request.
  6. Haga clic en Create pull request.

¡Listo! Su PR estará abierto y el equipo de mantenimiento podrá revisarlo.

9. Espere revisión

  • El equipo de mantenimiento revisará su Pull Request.
  • Puede que le pidan cambios o sugerencias antes de aprobarlo.

10. ¡Listo!

  • Cuando su Pull Request sea aceptado, su contribución formará parte del proyecto.

Reporte de Bugs y Propuestas de Funcionalidades

¿Cómo reportar un bug?

  • Diríjase a la sección de Issues del repositorio.
  • Haga clic en New Issue y seleccione Reporte de Bug.
  • Llene la plantilla como se indica.
  • No incluya información sensible o privada.

¿Cómo proponer una nueva funcionalidad?

  • Vaya a la sección de Issues.
  • Haga clic en New Issue y seleccione la plantilla Solicitud de Feature.
  • Llene la plantilla como se indica.

Consejos

  • Lea el CODE_OF_CONDUCT.md antes de contribuir.
  • Lea los archivos en la carpeta documentacion/.
  • Lea STYLE_GUIDE.md antes de hacer PR.
  • Sea respetuoso y paciente en las discusiones.
  • Si tiene dudas, abra un issue o pregunte en el Pull Request.

¡Gracias por ayudar a mejorar ComidaEmergencia!