Git Product home page Git Product logo

ideuy-py's People

Contributors

jimenamv avatar munshkr avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

ideuy-py's Issues

Issue de revisión de documentación

Este issue forma parte del proceso de revisión del Laboratoria Code Squads Noviembre 2020 de la iniciativa Código para el Desarrollo de @EL-BID

Issue de revisión de documentación - readme.md:

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 ] 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.
  • [x ] 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.
  • [x ] 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.
  • Añadir un apartado especificando la licencia open source que se esté usando redirigiendo al archivo LICENSE.md.

Issue de evaluación técnica

Este issue forma parte del proceso de revisión del Laboratoria Code Squads Noviembre 2020 de la iniciativa Código para el desarrollo del @EL-BID.

Issue de revisión de evaluación técnica:

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 microservicio de reportes de evaluación estática de código de Sonarcloud, teniendo en cuenta que las condiciones ideales de los reportes son:

    1 Ausencia de fallos estructurales
    2 Menos del 25% de líneas duplicadas
    3 Menos de 10 problemas críticos
    4 Más del 50% de clases, interfaces y métodos documentados
    5 Deuda técnica menor a 30 días
    6 Cobertura de test más del 25%
    
    Esto se valida automáticamente cuando corre el reporte del último commit del repositorio.
    
  • [x ] Agregar el badge en markdown de este servicio visible en el readme.md.

  • [x ] Agregar un microservicio de integración continua de código, recomendamos Travis CI (opcional).

  • [ x] Agregar el badge del microservicio de integración continua de código visible en el readme.md. El build debe estar en estado passing.(opcional).

  • [x ] Actualizar versión de todas las dependencias.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.