-
Notifications
You must be signed in to change notification settings - Fork 0
Description
Descripción del Problema:
Actualmente, nuestro proyecto no tiene badges visibles en el README. Los badges proporcionan información rápida y visual sobre el estado del proyecto, versiones de dependencias, cobertura de pruebas, y más. Incluir estos badges mejorará la visibilidad del estado del proyecto y ofrecerá a los usuarios y colaboradores información clave de manera inmediata. 🚀
Propuesta:
Me gustaría proponer la adición de varios badges en el README para proporcionar una visión rápida y completa del estado del proyecto. Los badges recomendados incluyen:
-
Estado del Build: Muestra si la última compilación del proyecto fue exitosa.
- Servicio: GitHub Actions, Travis CI, o CircleCI.
-
Versión de Python: Indica la versión de Python requerida para el proyecto.
- Servicio: Shields.io.
-
Licencia: Muestra la licencia bajo la cual se distribuye el proyecto.
- Servicio: Shields.io.
-
Dependencias: Muestra el estado de las dependencias del proyecto y si hay actualizaciones disponibles.
- Servicio: Dependabot, pyup.
-
Cobertura de Pruebas: Muestra el porcentaje de cobertura de pruebas del código.
-
Versiones del Proyecto: Muestra la versión actual del proyecto.
- Servicio: Shields.io.
Pasos para Implementar:
-
Seleccionar y agregar los badges:
- Estado del Build: Configurar y agregar el badge del servicio de CI/CD que se utiliza.
- Versión de Python: Utilizar Shields.io para crear un badge que indique la versión de Python.
- Licencia: Utilizar Shields.io para mostrar la licencia del proyecto.
- Dependencias: Configurar y agregar el badge de herramientas como Dependabot o pyup.
- Cobertura de Pruebas: Configurar y agregar el badge de servicios de cobertura como Codecov o Coveralls.
- Versiones del Proyecto: Utilizar Shields.io para mostrar la versión del proyecto.
-
Actualizar el README.md:
- Añadir los badges seleccionados en la parte superior del archivo
README.mdpara visibilidad inmediata. 📝
- Añadir los badges seleccionados en la parte superior del archivo
Beneficios:
- 📈 Visibilidad Rápida: Ofrece información clave del estado del proyecto de manera visual y accesible.
- 🔍 Transparencia: Muestra el estado del build, versión de Python, licencia, y cobertura de pruebas, facilitando la comprensión del estado del proyecto.
- 🔧 Mejora Continua: Facilita la monitorización de dependencias y la cobertura del proyecto, apoyando la mejora continua del código.
Archivos a Modificar:
- Archivo:
README.md
Notas Adicionales:
Si hay otros badges que se consideran útiles para el proyecto o si hay alguna preferencia en la selección de servicios, estoy abierto a sugerencias y ajustes. 🤝