Este issue forma parte de un procesos de revisión de la piloto @BID-COMUNIDADES/laboratoria-code-squads de la iniciativa Código para el desarrollo de @EL-BID.
Issue de revisión de documentación:
Al haber contrastado la información presentadas en el repo oficial con los campos solicitados en la plantilla de README.md hemos encontrado los siguiente puntos a mejorar:
[x] Agregar el logo para identificar el proyecto.
[x] Incluir badges con el estado de desarrollo, licencia, versión, coverage, sociales u otras. Esta herramienta puede ser de utilidad: https://shields.io/
[x] Proporcionar una tabla de contenidos con links para cada apartado.
[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.
[x] Añadir una serie de pasos que permitan la instalación y uso del proyecto de forma local.
[ ] 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 un apartado con el proceso detallado para contribuir al proyecto
Este issue forma parte de un procesos de revisión de la piloto @BID-COMUNIDADES/laboratoria-code-squads de la iniciativa Código para el desarrollo de @EL-BID.
Issue de revisión de documentación: Al haber contrastado la información presentadas en el repo oficial con los campos solicitados en la plantilla de README.md hemos encontrado los siguiente puntos a mejorar:
[x] Agregar el logo para identificar el proyecto.
[x] Incluir badges con el estado de desarrollo, licencia, versión, coverage, sociales u otras. Esta herramienta puede ser de utilidad: https://shields.io/
[x] Proporcionar una tabla de contenidos con links para cada apartado.
[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.
[x] Añadir una serie de pasos que permitan la instalación y uso del proyecto de forma local.
[ ] 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 un apartado con el proceso detallado para contribuir al proyecto