shields
1.0.0
Este es el hogar de Shields.io, un servicio para insignias concisas, consistentes y legibles en formato SVG y ráster, que se puede incluir fácilmente en GitHub Readmes o en cualquier otra página web. El servicio admite docenas de servicios de integración continua, registros de paquetes, distribuciones, tiendas de aplicaciones, redes sociales, servicios de cobertura de código y servicios de análisis de código. Cada mes sirve más de 1.600 millones de imágenes y es utilizado por algunos de los proyectos de código abierto más populares del mundo, VS Code, Vue.js y Bootstrap, por nombrar algunos.
Este repositorio aloja:
¡Haz tus propias insignias! (Ejemplo rápido: https://img.shields.io/badge/left-right-f39f37 )
Explore una lista completa de insignias y localice una insignia particular utilizando la barra de búsqueda o navegando por las categorías. Haga clic en la insignia para completar los elementos de datos requeridos para ese tipo de insignia (como su nombre de usuario o repositorio) y opcionalmente personalice (etiqueta, colores, etc.). ¡Y está listo para usar!
Use el botón en la parte inferior para copiar la URL o el fragmento de su insignia, que luego se puede agregar a lugares como sus archivos GitHub ReadMe u otras páginas web.
Shields es un proyecto comunitario. ¡Invitamos su participación a través de problemas y solicitudes de extracción! Puede examinar las pautas contribuyentes.
Al agregar o cambiar un servicio, agregue pruebas.
¡Este proyecto tiene una gran cartera de sugerencias! Si eres nuevo en el proyecto, tal vez te gustaría abrir una solicitud de extracción para abordar uno de ellos.
Puede leer un tutorial sobre cómo agregar una insignia.
Si tiene la intención de informar o contribuir con una solución relacionada con las vulnerabilidades de seguridad, primero consulte nuestra política de seguridad.
npm ci para instalar las dependencias.npm start para iniciar el servidor de la insignia y el servidor de desarrollo frontend.http://localhost:3000/ para ver el frontend. Cuando los archivos fuente del servidor cambian, el servidor de la insignia debe reiniciarse automáticamente (usando Nodemon). Cuando cambian los archivos frontend, el servidor de desarrollo frontend ( docusaurus start ) también debe volver a cargar automáticamente. Sin embargo, las definiciones de la insignia se construyen solo antes de que el servidor comience por primera vez. Para regenerarlos, ejecute npm run prestart o reiniciar manualmente el servidor.
Para depurar una insignia desde la línea de comando, ejecute npm run badge -- /npm/v/nock . También funciona con URL completa como npm run badge -- https://img.shields.io/npm/v/nock .
Use npm run debug:server para iniciar el servidor en modo de depuración. Esta receta muestra cómo depurar la aplicación Node.js en VS Code.
Shields tiene apoyo experimental para GitPod, un entorno de desarrollo preconfigurado que se ejecuta en su navegador. Para usar GitPod, haga clic en el botón de abajo e inicie sesión con GitHub. GitPod también ofrece un complemento de navegador, aunque no es necesario. Informe cualquier error, preguntas o sugerencias de GitPod en el número 2772.
Las pruebas de instantáneas aseguran que no realicemos cambios inadvertidamente que afecten la salida SVG o JSON. Cuando cambie deliberadamente la salida, ejecute SNAPSHOT_DRY=1 npm run test:package para ver los cambios de vista previa a las instantáneas guardadas y SNAPSHOT_UPDATE=1 npm run test:package para actualizarlos.
El servidor se puede configurar para usar Sentry (Configuración) y Prometheus (Configuración).
Nuestra suite de prueba completa y la cobertura de código se ejecutan a diario.
Hay documentación sobre alojar su propio servidor.
Las insignias de estado se utilizan ampliamente en proyectos de software privados y de código abierto. Los académicos han estudiado las insignias de "señal" que proporcionan sobre la calidad del proyecto de software. Hay muchas bibliotecas existentes para representar estas insignias y alternativas al servicio de insignia de escudos alojados. Awesome-Badges es una colección curada de tales recursos. Las contribuciones pueden considerarse allí. (La presencia de un proyecto en esa colección no debe interpretarse como un respaldo ni promoción del Proyecto Shields)
B.adge.me fue el sitio web original para este servicio. Heroku en ese entonces tenía algo que dificultaba usar un dominio de Toplevel, de ahí el dominio extraño. Utilizó el código desarrollado en 2013 a partir de una biblioteca llamada GH-Badges, ambos desarrollados por Thaddée Tyl. El proyecto se fusionó con Shields.io haciéndolo usar el código B.adge.me y cerrado B.adge.me.
La especificación de la insignia original fue desarrollada en 2013 por Olivier Lacan. Fue inspirado en el Travis CI y las insignias similares (había muchos menos, en aquel entonces). En 2014, Thaddée Tyl lo rediseñó con la ayuda de un empleado de Travis CI y convenció a todos para que cambiaran a él. El diseño antiguo es lo que hoy se llama estilo plástico; El nuevo es el estilo plano.
Puede leer más sobre el inicio del proyecto, la motivación de la especificación de la insignia SVG y la especificación en sí.
Mantenedores:
Alumni:
Todos los activos y código están bajo la licencia CC0 y en el dominio público a menos que se especifique lo contrario.
Gracias a las personas y empresas que donan dinero, servicios o tiempo para mantener el proyecto en funcionamiento. https://shields.io/community
