Skip to content

[FEATURE] Elaboración del README para el proyecto #2

Open

Description

@AASG2003

🔍 Verificaciones previas

  • 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions