Jedes Repository im öffentlichen Register trägt ein einbettbares Badge: eine kleine SVG-Grafik, die den aktuellen Gesundheitsindex und die Bewertungsstufe zeigt und auf den vollständigen Bericht verlinkt. Das Badge macht das Register dort sichtbar, wo Entscheidungen fallen – im README, neben der Installationsanleitung.
Ein Badge einbetten
Jede Berichtsseite stellt kopierfertige Snippets für ihr Repository bereit. Das Muster:
[](https://inspect.software/software/OWNER/REPO)<a href="https://inspect.software/software/OWNER/REPO">
<img src="https://raw.githubusercontent.com/inspect-software/badges/main/v1/O/OWNER/REPO.svg"
alt="inspect.software health badge for OWNER/REPO" />
</a>OWNER/REPO ist durch den vollständigen Namen des Repositorys zu ersetzen und O durch den ersten Buchstaben des Eigentümernamens in Kleinschreibung: Badges werden unter diesem Buchstaben abgelegt, damit kein Verzeichnis des Repositorys unübersichtlich groß wird. Wer die exakten Snippets von der Berichtsseite des Repositorys im öffentlichen Register kopiert, umgeht die Frage.
shields.io
Für READMEs, die auf shields.io-Badges standardisiert sind, ist das Register auch über das Endpoint-Badge von shields verfügbar. Jedes Repository liefert seinen aktuellen Stand als Endpoint-JSON unter https://inspect.software/badge/v1/OWNER/REPO.json, das shields in seiner eigenen Bildsprache rendert:
[](https://inspect.software/software/OWNER/REPO)Das gerenderte Badge nennt denselben Index, dasselbe Stufenvokabular und dieselbe Stufenfarbe wie das native Badge – zertifizierte Repositories führen mit ihrer Buchstabennote – und aktualisiert sich im selben stündlichen Rhythmus. Alle Stil-Parameter von shields (style=, logo=, …) gelten wie bei jedem anderen shields-Badge.
Wie sich Badges verhalten
- Immer aktuell. Das Badge spiegelt die zuletzt veröffentlichte Prüfung wider und aktualisiert sich nach jedem Scan automatisch – ein erneutes Einbetten ist nicht nötig.
- Von GitHub ausgeliefert. Die Badge-Grafiken werden im öffentlichen Repository inspect-software/badges veröffentlicht und von GitHubs eigenem Content-Netzwerk ausgeliefert. Ein README mit einem Badge hängt nicht davon ab, dass diese Website erreichbar ist.
- Versionierter Pfad. Das Pfadsegment
/v1/ist stabil; jede künftige Änderung an der Badge-Semantik erscheint als neue Version, niemals als stille Änderung. - In Stufenfarbe. Das Badge trägt die Farbe der aktuellen Stufe des Repositorys, vom tiefen Grün der Stufe Außergewöhnlich bis zum Rot der Stufe Kritisch, und nennt die Stufe in Worten neben dem Index.
- Zertifizierte Repositories tragen ein Siegel. Repositories in den drei obersten Stufen zeigen eine geprägte Rosette mit ihrer Buchstabennote – A, AA oder AAA –, das sichtbare Zeichen ihrer Zertifizierungsstufe. Das Siegel ist ein Zertifizierungszeichen, deshalb trägt ein Repository unterhalb der Stufe Gut keines; sein Badge nennt Stufe und Index ohne es.
- Eine einzige feste Größe. Jedes Badge misst 137×20 Pixel, was der Index auch sagt, sodass ein README nie neu umbricht, wenn sich ein Index bewegt, und eine Reihe von Badges bündig bleibt.
- Niemals defekt. Ein Repository, das noch nicht im Register steht, liefert ein neutrales Badge statt eines defekten Bildes.
Was ein Badge aussagt
Ein Badge sagt genau das aus, was der dahinterliegende Bericht aussagt: gemessene, öffentlich sichtbare Praxis nach einer versionierten Methodik – und nicht mehr. Es ist ein Signal zur Prüfung, keine Garantie für Qualität oder Sicherheit (siehe Signale, keine Garantien). Der verlinkte Bericht zeigt stets das vollständige Kategorienprofil, die Komponenten jeder Metrik und die Rohdaten.
Ein Badge erhalten
- Das Repository auf der Startseite einreichen (GitHub-Anmeldung erforderlich).
- Repositories mit hohem öffentlichem Wert werden kostenlos geprüft; alle übrigen folgen dem Zertifizierungsweg.
- Nach Veröffentlichung des Berichts die Badge-Snippets von der Berichtsseite kopieren.