Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revisión de documentación #2

Open
Paotm opened this issue Dec 9, 2020 · 0 comments
Open

Revisión de documentación #2

Paotm opened this issue Dec 9, 2020 · 0 comments

Comments

@Paotm
Copy link

Paotm commented Dec 9, 2020

Después de revisar la documentación con el repositorio y compararla con los campos solicitados en la plantilla de readme.md hemos detectado los siguiente puntos a mejorar:

[ x] Agregar el logo para identificar el proyecto.
[x ] Agregar una imagen o gif del proyecto para identificar su funcionalidad principal.
[x ] Incluir badges con el estado de desarrollo, licencia, versión, coverage, sociales u otras. Esta herramienta puede ser de utilidad: https://shields.io/ (tutorial recomendado: https://www.youtube.com/watch?v=SIh5MQoQLPs)
[ x] Proporcionar una tabla de contenidos con links para cada apartado para que funcione como índice.
[x ] Especificar los pre-requisitos necesarios para ejecutar el proyecto (environment, librerías, dependencias, entre otros), y proporcionar comandos de instalación de los mismos.
[ x] Precisar si se requieren variables de entorno y en qué parte de la arquitectura se colocan.
[ ] Añadir una serie de pasos que permitan la instalación y uso del proyecto de forma local.
[x ] Añadir comando de ejecución para pruebas unitarias.
[ x] Hacer mención de las tecnologías utilizadas y añadir enlaces haciendo referencia a la documentación de cada una.
[ ] Si es preciso, añadir fragmentos de código con ejemplos de uso.
[ x] Añadir sección autor@s.
[x ] Añadir un apartado con el proceso detallado para contribuir al proyecto.
[x]Añadir un apartado especificando la licencia open source que se esté usando redirigiendo al archivo LICENSE.md.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant