Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (38 loc) · 2.69 KB

CONTRIBUTING.md

File metadata and controls

55 lines (38 loc) · 2.69 KB

Guía de Contribución para Fasttify-Core

¡Gracias por tu interés en contribuir a Fasttify-Core! Agradecemos cualquier ayuda, ya sea reportando errores, sugiriendo nuevas funcionalidades o enviando código.

Cómo Contribuir

Hay varias formas en las que puedes contribuir:

Reportar Errores

Si encuentras un error en el código o un problema en la documentación, por favor:

  1. Busca en los Issues existentes: Asegúrate de que el error no haya sido reportado previamente.
  2. Abre un nuevo Issue: Si no encuentras un issue similar, crea uno nuevo. Proporciona la mayor cantidad de detalles posible, incluyendo:
    • Una descripción clara y concisa del error.
    • Pasos para reproducir el error.
    • El comportamiento esperado.
    • El comportamiento actual.
    • Capturas de pantalla o logs si son relevantes.
    • Información sobre tu entorno (versión del proyecto, sistema operativo, etc.).

Sugerir Mejoras o Nuevas Funcionalidades

Si tienes ideas para mejorar el proyecto o nuevas funcionalidades que te gustaría ver:

  1. Busca en los Issues existentes: Comprueba si alguien ya ha sugerido algo similar.
  2. Abre un nuevo Issue: Describe tu sugerencia detalladamente. Explica por qué crees que sería útil y cómo podría implementarse.

Enviar Pull Requests

Si quieres contribuir con código o documentación:

  1. Haz un Fork del Repositorio: Crea una copia del repositorio en tu cuenta de GitHub.
  2. Crea una Nueva Rama: Crea una rama descriptiva para tus cambios (ej. fix/nombre-error o feat/nueva-funcionalidad).
  3. Realiza tus Cambios: Escribe tu código siguiendo las guías de estilo del proyecto (si existen) y asegúrate de que las pruebas pasen (si hay pruebas).
  4. Escribe Pruebas: Si estás añadiendo una nueva funcionalidad o corrigiendo un error, añade pruebas que cubran tus cambios.
  5. Documenta tus Cambios: Actualiza la documentación si es necesario.
  6. Haz Commit de tus Cambios: Usa mensajes de commit claros y descriptivos.
  7. Envía un Pull Request (PR):
    • Ve a tu fork y haz clic en "New pull request".
    • Asegúrate de que la rama base sea la correcta (normalmente main o master).
    • Proporciona un título claro y una descripción detallada de tus cambios en el PR.
    • Enlaza cualquier Issue relacionado.

Proceso de Revisión

  • Un mantenedor revisará tu PR.
  • Puede que se te pidan cambios o aclaraciones.
  • Una vez aprobado, tu PR será fusionado.

Código de Conducta

Esperamos que todos los contribuyentes sigan nuestro Código de Conducta (si existe, de lo contrario, considera añadir uno basado en el Contributor Covenant).

¡Gracias de nuevo por tu contribución!