Skip to content

Latest commit

 

History

History
38 lines (27 loc) · 2.2 KB

File metadata and controls

38 lines (27 loc) · 2.2 KB

🏗 Guía de Contribución

¡Gracias por tu interés en contribuir a este proyecto! Queremos que este sea un espacio colaborativo, amigable y productivo. Para lograrlo, hemos establecido algunas pautas que te ayudarán a entender cómo puedes aportar de la mejor manera.

¿Cómo Contribuir?

  1. Reportar Bugs:

    • Si encuentras un error, revisa primero los Issues existentes para ver si ya se reportó.
    • Si no existe un reporte similar, crea uno utilizando la plantilla de "Reporte de Bug".
    • Sé claro y detallado: describe el problema, los pasos para reproducirlo, el comportamiento esperado y, de ser posible, incluye capturas de pantalla.
  2. Sugerir Mejoras o Nuevas Funcionalidades:

    • Crea un nuevo Issue si tienes una idea para mejorar la documentación, agregar una funcionalidad o cambiar la organización del repositorio.
    • Explica la motivación detrás de tu sugerencia y cómo beneficiará a otros usuarios.
  3. Enviar Pull Requests (PRs):

    • Antes de hacer cambios grandes, abre un Issue para discutir tu idea.
    • Crea una rama con un nombre descriptivo y realiza tus cambios en ella.
    • Asegúrate de seguir las convenciones del proyecto (estilo de código, formateo Markdown, etc.).
    • Incluye una descripción clara de los cambios en la PR y sigue la plantilla de Pull Request.
  4. Revisar PRs y Ayudar a Otros Contribuyentes:

    • Si tienes experiencia, puedes revisar PRs de otros.
    • Deja comentarios constructivos y respetuosos, y ayuda a mantener el nivel de calidad del proyecto.

Estilo y Buenas Prácticas

  • Código Limpio: Evita código innecesario, comentarios redundantes o duplicación.
  • Documentación: Añade o actualiza documentación si agregas funcionalidades nuevas o cambias el comportamiento de las existentes.
  • Pruebas: Si es aplicable, incluye pruebas unitarias o de integración para los cambios que hagas.

Comunicación

  • Sé respetuoso y considerado con los demás colaboradores.
  • Evita lenguaje ofensivo o comentarios personales.
  • Si no estás seguro de algo, pregunta. Es mejor aclarar las dudas antes de avanzar con cambios incorrectos.

¡Gracias por ayudar a que este proyecto mejore continuamente!