Skip to content

Latest commit

 

History

History
110 lines (71 loc) · 3.23 KB

CONTRIBUTING.md

File metadata and controls

110 lines (71 loc) · 3.23 KB

Guía de Contribución

¡Gracias por tu interés en contribuir a este proyecto! Apreciamos tu ayuda para mejorar y expandir esta plantilla de API en Node.js. Sigue estas pautas para garantizar que el proceso de contribución sea claro y eficiente.

Cómo empezar

  1. Fork del repositorio
    Crea un fork de este repositorio haciendo clic en el botón Fork en la esquina superior derecha de esta página.

  2. Clona el repositorio
    Clona tu fork a tu máquina local:

git clone https://github.com/Organization-DevXP/CRUD-Users-Nodejs-Express-MySQL.git
cd CRUD-Users-Nodejs-Express-MySQL
  1. Crea una rama para tus cambios Utiliza una rama separada para tus contribuciones. Usa un nombre descriptivo para la rama:
git checkout -b feature/nueva-funcionalidad
  1. Instala las dependencias Instala todas las dependencias necesarias para el proyecto:
npm install
  1. Asegúrate de que las pruebas pasen Ejecuta los tests existentes para confirmar que todo funciona correctamente:
npm test

Cómo contribuir

Reportar problemas

Si encuentras un error o tienes una idea para mejorar el proyecto:

  1. Abre un nuevo issue aquí.
  2. Describe el problema o la mejora de manera clara. Incluye detalles como:
    • Pasos para reproducir el problema.
    • Versión de Node.js utilizada.
    • Comportamiento esperado vs. actual.

Hacer cambios al código

  1. Realiza tus cambios en la rama que creaste.
  2. Asegúrate de seguir las convenciones de estilo del proyecto (puedes usar herramientas como Prettier y ESLint).
  3. Agrega pruebas para cualquier funcionalidad nueva o cambios importantes.

Realizar un Pull Request

Cuando hayas terminado tus cambios:

  1. Confirma tus cambios con un mensaje claro:
git commit -m "feat: descripción breve del cambio"
  1. Haz push de tu rama al fork:
git push origin feature/nueva-funcionalidad

  1. Abre un Pull Request desde tu fork hacia el repositorio original.

  2. Llena la plantilla del Pull Request (si está disponible) con información detallada sobre tus cambios.

Revisión de código

Tu Pull Request será revisado por los mantenedores del proyecto. Es posible que te pidan realizar ajustes antes de que sea aceptado.

Pautas de estilo

Ejemplos de mensajes de commit

  • feat: agregar autenticación con JWT
  • fix: corregir error en la validación de usuarios
  • docs: actualizar documentación de endpoints

Recursos útiles

Código de Conducta

Este proyecto sigue un Código de Conducta. Por favor, revísalo antes de contribuir.

¡Gracias por tu contribución! 🚀
Si tienes preguntas o necesitas ayuda, no dudes en abrir un issue o contactar a los mantenedores.