Кожен репозиторій у публічному реєстрі має вбудовуваний бейдж: невелике SVG-зображення з поточним індексом здоров'я та рейтинговим діапазоном, що веде до повного звіту. Бейдж робить реєстр видимим там, де ухвалюються рішення, — у README, поруч з інструкціями зі встановлення.
Вбудовування бейджа
Сторінка кожного звіту містить готові до копіювання фрагменти для свого репозиторію. Шаблон:
[](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 на повну назву репозиторію, а O — на першу літеру імені власника в нижньому регістрі: бейджі розкладено за цією літерою, щоб жоден каталог у репозиторії не розростався до неосяжного. Копіювання точних фрагментів зі сторінки звіту репозиторію в публічному реєстрі убезпечує від помилки.
shields.io
Для README, стандартизованих на бейджах shields.io, реєстр доступний і через endpoint-бейдж shields. Кожен репозиторій віддає свій поточний стан як endpoint-JSON за адресою https://inspect.software/badge/v1/OWNER/REPO.json, який shields рендерить у власній візуальній мові:
[](https://inspect.software/software/OWNER/REPO)Відрендерений бейдж називає той самий індекс, ту саму лексику діапазонів і той самий колір діапазону, що й рідний бейдж — сертифіковані репозиторії ведуть своєю літерною оцінкою — та оновлюється за тим самим щогодинним розкладом. Усі стильові параметри shields (style=, logo=, …) діють, як у будь-якого іншого бейджа shields.
Як поводяться бейджі
- Завжди актуальні. Бейдж відображає останню опубліковану інспекцію та оновлюється автоматично після кожного сканування — повторне вбудовування не потрібне.
- Віддаються з GitHub. Зображення бейджів публікуються в публічному репозиторії inspect-software/badges і доставляються власною мережею доставки контенту GitHub. README з бейджем не залежить від доступності цього сайту.
- Версіонований шлях. Сегмент шляху
/v1/стабільний; будь-яка майбутня зміна семантики бейджа виходить як нова версія, ніколи — як мовчазна зміна. - Колір за діапазоном. Бейдж має колір поточного діапазону репозиторію — від глибокого зеленого виняткового до червоного критичного — і називає діапазон словами поруч з індексом.
- Сертифіковані репозиторії несуть печатку. Репозиторії у трьох верхніх діапазонах показують рельєфну розетку з їхньою літерною оцінкою — A, AA чи AAA — видимий знак їхнього рівня сертифікації. Печатка є сертифікаційним знаком, тож репозиторій нижче за Добрий її не несе; його бейдж називає діапазон та індекс без неї.
- Один незмінний розмір. Кожен бейдж має 137×20 пікселів, хай там що показує індекс, тож README ніколи не перебудовується, коли індекс зрушується, а ряд бейджів лишається рівним.
- Ніколи не ламаються. Для репозиторію, якого ще немає в реєстрі, видається нейтральний бейдж, а не зламане зображення.
Що стверджує бейдж
Бейдж стверджує рівно те, що стверджує звіт за ним: виміряні, публічно видимі практики за версіонованою методологією — і нічого більше. Це сигнал для розгляду, а не гарантія якості чи безпеки (див. сигнали, а не гарантії). Звіт за посиланням завжди показує повний профіль за категоріями, компоненти кожної метрики та вихідні дані.
Як отримати бейдж
- Подайте репозиторій на головній сторінці (потрібен вхід через GitHub).
- Репозиторії з високою суспільною цінністю інспектуються безкоштовно; решта проходить шлях сертифікації.
- Після публікації звіту скопіюйте фрагменти бейджа зі сторінки звіту.