Saltar a contenido

Guía de Contribución

🤝 ¿Cómo Contribuir?

¡Gracias por tu interés en contribuir a UBI COPEC API! Este proyecto es open source y todas las contribuciones son bienvenidas.

📝 Proceso de Contribución

  1. Fork el Repositorio
  2. Visita el repositorio en GitHub
  3. Haz click en el botón "Fork"

  4. Clona tu Fork

    git clone https://github.com/TU-USERNAME/UBI-COPEC.git
    cd UBI-COPEC
    

  5. Crea una Rama

    git checkout -b feature/tu-feature
    

  6. Realiza tus Cambios

  7. Escribe código limpio y mantenible
  8. Sigue las convenciones de estilo del proyecto
  9. Añade tests si es necesario
  10. Actualiza la documentación si es necesario

  11. Commit tus Cambios

    git add .
    git commit -m "feat: descripción de tus cambios"
    
    Usamos Conventional Commits:

  12. feat: para nuevas características
  13. fix: para correcciones de bugs
  14. docs: para cambios en documentación
  15. test: para añadir o modificar tests
  16. refactor: para refactorización de código

  17. Push a tu Fork

    git push origin feature/tu-feature
    

  18. Crea un Pull Request

  19. Ve a tu fork en GitHub
  20. Click en "New Pull Request"
  21. Describe tus cambios
  22. Referencia cualquier issue relacionado

🧪 Tests

Antes de enviar tu PR, asegúrate de que:

  1. Todos los tests pasan:

    pytest
    

  2. El código sigue el estilo del proyecto:

    flake8
    black .
    

📋 Checklist PR

  • He seguido las guías de contribución
  • He añadido tests si era necesario
  • He actualizado la documentación si era necesario
  • He verificado que todos los tests pasan
  • He seguido las convenciones de commit

🐛 Reportar Bugs

  • Usa el issue tracker
  • Describe el bug con detalle
  • Incluye pasos para reproducirlo
  • Menciona tu entorno (OS, Python version, etc.)

💡 Proponer Mejoras

  • Abre un issue describiendo tu propuesta
  • Explica por qué sería útil
  • Discute posibles implementaciones
  • Espera feedback antes de empezar a trabajar

📜 Código de Conducta

Este proyecto sigue el Contributor Covenant. Al participar, se espera que respetes este código.