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.
-
Versi贸n de Python: Indica la versi贸n de Python requerida para el proyecto.
-
Licencia: Muestra la licencia bajo la cual se distribuye el proyecto.
-
Dependencias: Muestra el estado de las dependencias del proyecto y si hay actualizaciones disponibles.
-
Cobertura de Pruebas: Muestra el porcentaje de cobertura de pruebas del c贸digo.
-
Versiones del Proyecto: Muestra la versi贸n actual del proyecto.
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.md para visibilidad inmediata. 馃摑
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:
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. 馃
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.
Versi贸n de Python: Indica la versi贸n de Python requerida para el proyecto.
Licencia: Muestra la licencia bajo la cual se distribuye el proyecto.
Dependencias: Muestra el estado de las dependencias del proyecto y si hay actualizaciones disponibles.
Cobertura de Pruebas: Muestra el porcentaje de cobertura de pruebas del c贸digo.
Versiones del Proyecto: Muestra la versi贸n actual del proyecto.
Pasos para Implementar:
Seleccionar y agregar los badges:
Actualizar el README.md:
README.mdpara visibilidad inmediata. 馃摑Beneficios:
Archivos a Modificar:
README.mdNotas 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. 馃