Skip to content

Latest commit

 

History

History
94 lines (71 loc) · 3.28 KB

CONTRIBUTING.md

File metadata and controls

94 lines (71 loc) · 3.28 KB

🛠 Contribuir al proyecto

¡Gracias por tu interés en contribuir a Cuánto vale tu outfit en Inditex! 🖤 Tu ayuda es clave para mejorar esta aplicación y hacerla aún más útil para la comunidad.

📜 Código de conducta

Nos comprometemos a mantener un ambiente inclusivo, respetuoso y colaborativo. Por favor, revisa nuestro Código de Conducta antes de contribuir.

🔍 Antes de contribuir

Antes de empezar, revisa lo siguiente:

  • Issues abiertos en GitHub para ver si alguien ya está trabajando en la mejora o el problema que quieres abordar.
  • Discusiones previas en la pestaña de "Discussions" o en los comentarios de los issues.
  • La documentación para entender cómo funciona el proyecto.

Si no encuentras la información que buscas, no dudes en abrir un nuevo issue.

🚀 ¿Cómo contribuir?

🐛 Reportar bugs

Si encuentras un error, abre un issue con esta información:

  1. Descripción clara del problema.
  2. Pasos para reproducirlo.
  3. Comportamiento esperado vs. real.
  4. Logs o capturas de pantalla si es relevante.

💡 Sugerir mejoras

Si tienes una idea para mejorar la app:

  1. Revisa los issues existentes.
  2. Abre un nuevo issue con una descripción detallada.
  3. Si quieres implementarlo tú mismo, indícalo en el issue y sigue el proceso de pull requests.

📝 Mejorar la documentación

¡La documentación clara es clave! Puedes ayudar:

  • Corrigiendo errores en el README.md u otros archivos.
  • Explicando mejor procesos o funcionalidades.
  • Agregando ejemplos o tutoriales.

🔄 Enviar código (Pull Requests)

Si quieres contribuir con código, sigue estos pasos:

  1. Haz un fork del repositorio.
  2. Crea una rama descriptiva: git checkout -b feature/nueva-funcionalidad.
  3. Haz cambios y haz commit: 
    git commit -m "Añadir nueva funcionalidad X"
  4. Haz push de tu rama a tu fork: 
    git push origin feature/nueva-funcionalidad
  5. Abre un Pull Request (PR) en el repositorio principal.

🔍 Proceso de revisión de código

  1. Un colaborador revisará tu PR.
  2. Se podrán pedir cambios o aclaraciones.
  3. Una vez aprobado, se hará merge en main.
  4. ¡Tu contribución aparecerá en la próxima versión! 🎉

🛠 Estilo de código y convenciones

  • Usa Python 3.10.
  • Sigue la estilo de formateo de black como estándar de estilo.
  • Usa tipado estático en las funciones.
  • Mantén el código modular y reutilizable.

✅ Pruebas y criterios de aceptación

Antes de enviar un PR:

  • Asegúrate de que el código no rompe funcionalidades existentes.
  • Ejecuta los tests si existen.
  • Verifica que cumple con los requisitos del issue.

🤝 Dónde nos reunimos

🌱 ¿Por dónde empezar?

Si eres nuevo, busca issues etiquetados como good first issue o help wanted.

¡Gracias por tu ayuda! 💙