shields
1.0.0
Ceci abrite Shields.io, un service pour des badges concis, cohérents et lisibles au format SVG et raster, qui peut facilement être inclus dans GitHub Readmes ou toute autre page Web. Le service prend en charge des dizaines de services d'intégration continue, de registres de packages, de distributions, de magasins d'applications, de réseaux sociaux, de services de couverture de code et de services d'analyse de code. Chaque mois, il dessert plus de 1,6 milliard d'images et est utilisé par certains des projets open-source les plus populaires au monde, VS Code, Vue.js et Bootstrap pour n'en nommer que quelques-uns.
Ce repo héberge:
Faites vos propres badges! (Exemple rapide: https://img.shields.io/badge/left-right-f39f37 )
Parcourez une liste complète des badges et localisez un badge particulier en utilisant la barre de recherche ou en parcourant les catégories. Cliquez sur le badge pour remplir les éléments de données requis pour ce type de badge (comme votre nom d'utilisateur ou votre repo) et éventuellement personnaliser (étiquette, couleurs, etc.). Et c'est prêt à l'emploi!
Utilisez le bouton en bas pour copier votre URL ou l'extrait de votre badge, qui peut ensuite être ajouté à des endroits comme vos fichiers GitHub Readme ou d'autres pages Web.
Shields est un projet communautaire. Nous invitons votre participation à travers des problèmes et des demandes de traction! Vous pouvez parcourir les directives contributives.
Lors de l'ajout ou de la modification d'un service, veuillez ajouter des tests.
Ce projet a tout un arriéré de suggestions! Si vous êtes nouveau dans le projet, vous souhaitez peut-être ouvrir une demande de traction pour résoudre l'un d'entre eux.
Vous pouvez lire un tutoriel sur la façon d'ajouter un badge.
Si vous avez l'intention de signaler ou de contribuer à un correctif lié aux vulnérabilités de sécurité, veuillez d'abord vous référer à notre politique de sécurité.
npm ci pour installer les dépendances.npm start pour démarrer le serveur de badges et le serveur de développement frontal.http://localhost:3000/ pour afficher le frontend. Lorsque les fichiers source du serveur changent, le serveur de badge doit se redémarrer automatiquement (à l'aide de nodemon). Lorsque les fichiers Frontend changent, le serveur de développement frontal ( docusaurus start ) doit également recharger automatiquement. Cependant, les définitions de badge ne sont construites que avant le début du serveur. Pour les régénérer, exécutez npm run prestart ou redémarrez manuellement le serveur.
Pour déboguer un badge à partir de la ligne de commande, exécutez npm run badge -- /npm/v/nock . Il fonctionne également avec des URL complètes comme npm run badge -- https://img.shields.io/npm/v/nock .
Utilisez npm run debug:server pour démarrer le serveur en mode débogage. Cette recette montre comment déboguer l'application Node.js dans le code vs.
Shields a un support expérimental pour Gitpod, un environnement de développement préconfiguré qui fonctionne dans votre navigateur. Pour utiliser Gitpod, cliquez sur le bouton ci-dessous et connectez-vous avec GitHub. Gitpod propose également un module complémentaire de navigateur, bien qu'il ne soit pas nécessaire. Veuillez signaler tout bogue, questions ou suggestions Gitpod dans le numéro 2772.
Les tests d'instantané garantissent que nous n'apportez pas par inadvertance des modifications qui affectent la sortie SVG ou JSON. Lorsque vous modifiez délibérément la sortie, exécutez SNAPSHOT_DRY=1 npm run test:package pour prévisualiser les modifications des instantanés enregistrés, et SNAPSHOT_UPDATE=1 npm run test:package pour les mettre à jour.
Le serveur peut être configuré pour utiliser Sentry (configuration) et Prometheus (configuration).
Notre suite de test complète ainsi que la couverture du code sont exécutées quotidiennement.
Il y a une documentation sur l'hébergement de votre propre serveur.
Les badges de statut sont largement utilisés dans les projets logiciels open-source et privés. Les universitaires ont étudié les badges "Signal" sur la qualité du projet logiciel. Il existe de nombreuses bibliothèques existantes pour rendre ces badges et des alternatives au service de badge Hosted Shields. Awesome Badges est une collection organisée de ces ressources. Les contributions peuvent y être considérées. (La présence d'un projet dans cette collection ne doit pas être interprétée comme une approbation ni une promotion du projet Shields)
B.Adge.me était le site Web d'origine de ce service. Heroku à l'époque avait une chose qui rendait difficile d'utiliser un domaine de niveau supérieur avec, d'où le domaine étrange. Il a utilisé du code développé en 2013 à partir d'une bibliothèque appelée gh-badges, tous deux développés par Thaddee Tyl. Le projet a fusionné avec Shields.io en lui faisant utiliser le code b.adge.me et fermé B.Adge.me.
La spécification du badge d'origine a été développée en 2013 par Olivier Lacan. Il a été inspiré par le Travis CI et des badges similaires (il y avait beaucoup moins, à l'époque). En 2014, Thaddee Tyl l'a redessinée avec l'aide d'un employé de Travis CI et a convaincu tout le monde d'y passer. L'ancien design est ce qu'aujourd'hui est appelé le style en plastique; Le nouveau est le style plat.
Vous pouvez en savoir plus sur la création du projet, la motivation de la spécification du badge SVG et la spécification elle-même.
RETENUSEURS:
Anciennes:
Tous les actifs et le code sont sous la licence CC0 et dans le domaine public, sauf indication contraire.
Merci aux personnes et aux entreprises qui donnent de l'argent, des services ou du temps pour maintenir le projet en cours. https://shields.io/community
