You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
[FEATURE] Elaboración del README para el proyecto #2
Busqué issues existentes y no encontré uno similar
🧩 Tipo de mejora
🛠️ Desarrollo - nueva funcionalidad o cambio en el código
📄 Documentación - mejorar el README, guías, comentarios en código o ejemplos
♿ Accesibilidad - mejorar la experiencia para personas con discapacidad
⚡ Rendimiento - optimización de velocidad, uso de memoria o recursos
🎨 UI / UX - cambios en la interfaz o experiencia de usuario
🧪 Testing - agregar o mejorar pruebas automatizadas
🔧 Infraestructura / DevOps - CI/CD, despliegue, configuración de entornos
📚 Contenido - mejoras o correcciones en el contenido, como blogs, tutoriales o recursos educativos
✨ Descripción de la propuesta
Actualmente el respositorio no cuenta con un README para su puesta en marcha y configuración del proyecto, se propone hacer el README correspondiente al proyecto.
🎯 Problema que resuelve
No existe la documentación adecuada para la configuración del proyecto, dificultando el uso para nuevos usarios o desarrolladores.
👤 Caso de uso
Como usuario me gustaría utilizar y configurar el proyecto.
💡 Solución propuesta
Mi propuestas es implementar el README del proyceto, detallando la instalación y configuración para distintos entornos, además de indicar las versiones de python con las cuales el proyecto se ejecuta.
🚀 Impacto esperado
Este cambio agiliza la puesta en marcha para desarrolladores, colaboradores y usuarios, agilizando y guiando el despliegue del proyecto.
🔍 Alternativas consideradas
Elaborar el README es necesario para documentar el proyecto
✅ Criterios de aceptación
El usuario / desarrollador sigue los pasos citados
El proyecto ejecuta correctamente
🤝 ¿Te gustaría contribuir con esto?
Por ahora solo propongo la idea
📎 Recursos adicionales
Revisar las versiones correspondientes donde funciona el proyecto, ya que con python 3.13 la instalación no se realiza correctamente porque varias funciones se descartaron. El proyecto se ejecutó correctamente en la versión 3.11
Activity