shields

Le dépôt héberge Shields.io, un service permettant de créer des badges concis, cohérents et lisibles aux formats SVG et matriciel. Le README indique que les badges peuvent être intégrés dans les readmes GitHub ou toute autre page web. Il précise que le service prend en charge des dizaines de services d’intégration continue, registres de paquets, distributions, boutiques d’applications, réseaux sociaux, services de couverture de code et services d’analyse de code. Il indique qu’il sert plus de 1,6 milliard d’images chaque mois et qu’il est utilisé par des projets tels que VS Code, Vue.js et Bootstrap. Le dépôt héberge le code frontend et serveur de Shields.io, une bibliothèque NPM de génération de badges appelée badge-maker, ainsi que la spécification de conception des badges. Parmi les exemples cités figurent le pourcentage de couverture de code, la version de publication stable, la version du gestionnaire de paquets, l’état des dépendances, la note d’analyse statique de code, la version SemVer, les dons hebdomadaires Liberapay, les téléchargements de paquets Python, la note d’extension Chrome Web Store et le pourcentage de disponibilité Uptime Robot. Les utilisateurs peuvent créer des badges personnalisés avec un modèle d’URL. Le README décrit un démarrage rapide : les utilisateurs parcourent une liste complète de badges, recherchent ou explorent des catégories, cliquent sur un badge pour renseigner les données requises comme le nom d’utilisateur ou le dépôt, personnalisent éventuellement le libellé et les couleurs, puis copient l’URL ou l’extrait du badge pour les readmes GitHub ou d’autres pages web. La contribution est communautaire, via des issues et des pull requests ; le README demande aux contributeurs d’ajouter des tests lors de l’ajout ou de la modification d’un service, et renvoie à un tutoriel sur l’ajout d’un badge. Il mentionne également les good first issues et une politique de sécurité. Pour le développement, le README indique d’installer Node 24, de cloner le dépôt, d’exécuter npm ci, npm start, puis d’ouvrir localhost:3000. Les modifications du code source du serveur déclenchent un redémarrage via nodemon, tandis que les modifications du frontend sont rechargées via le serveur de développement Docusaurus ; les définitions de badges sont générées avant le premier démarrage du serveur et peuvent être régénérées avec npm run prestart ou un redémarrage. Un badge peut être débogué en ligne de commande avec npm run badge, y compris avec des URL complètes. Des tests de snapshot protègent la sortie SVG ou JSON ; les changements volontaires de sortie peuvent être prévisualisés avec SNAPSHOT_DRY=1 npm run test:package et mis à jour avec SNAPSHOT_UPDATE=1. Le serveur peut éventuellement utiliser Sentry et Prometheus. La documentation d’auto-hébergement est liée. Parmi les projets associés figure awesome-badges, une collection organisée. Le README retrace l’histoire : b.adge.me était le site d’origine, utilisant du code de 2013 issu de gh-badges ; le projet a fusionné avec shields.io. La spécification originale des badges a été développée en 2013, puis redessinée en 2014 ; l’ancien design est appelé plastic style et le nouveau flat style. Les mainteneurs et anciens membres sont listés, et le projet est sous double licence MIT et Apache 2.0. Il renvoie aussi au financement et au soutien de la communauté.