inspect.software

Бейджі GitHub

Вбудовувані бейджі inspect.software — живий сигнал здоров'я для будь-якого проінспектованого репозиторію, що оновлюється автоматично після кожного сканування. Фрагменти Markdown та HTML.

Оновлено 2026-07-17

Кожен репозиторій у публічному реєстрі має вбудовуваний бейдж: невелике SVG-зображення з поточним індексом здоров'я та рейтинговим діапазоном, що веде до повного звіту. Бейдж робить реєстр видимим там, де ухвалюються рішення, — у README, поруч з інструкціями зі встановлення.

Вбудовування бейджа

Сторінка кожного звіту містить готові до копіювання фрагменти для свого репозиторію. Шаблон:

[![inspect.software](https://raw.githubusercontent.com/inspect-software/badges/main/v1/O/OWNER/REPO.svg)](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 — на першу літеру імені власника в нижньому регістрі: бейджі розкладено за цією літерою, щоб жоден каталог у репозиторії не розростався до неосяжного. Копіювання точних фрагментів зі сторінки звіту репозиторію в публічному реєстрі убезпечує від помилки.

Як поводяться бейджі

  • Завжди актуальні. Бейдж відображає останню опубліковану інспекцію та оновлюється автоматично після кожного сканування — повторне вбудовування не потрібне.
  • Віддаються з GitHub. Зображення бейджів публікуються в публічному репозиторії inspect-software/badges і доставляються власною мережею доставки контенту GitHub. README з бейджем не залежить від доступності цього сайту.
  • Версіонований шлях. Сегмент шляху /v1/ стабільний; будь-яка майбутня зміна семантики бейджа виходить як нова версія, ніколи — як мовчазна зміна.
  • Колір за діапазоном. Бейдж має колір поточного діапазону репозиторію — від зеленого відмінного до червоного критичного.
  • Ніколи не ламаються. Для репозиторію, якого ще немає в реєстрі, видається нейтральний бейдж, а не зламане зображення.

Що стверджує бейдж

Бейдж стверджує рівно те, що стверджує звіт за ним: виміряні, публічно видимі практики за версіонованою методологією — і нічого більше. Це сигнал для розгляду, а не гарантія якості чи безпеки (див. сигнали, а не гарантії). Звіт за посиланням завжди показує повний профіль за категоріями, компоненти кожної метрики та вихідні дані.

Як отримати бейдж

  1. Подайте репозиторій на головній сторінці (потрібен вхід через GitHub).
  2. Репозиторії з високою суспільною цінністю інспектуються безкоштовно; решта проходить шлях сертифікації.
  3. Після публікації звіту скопіюйте фрагменти бейджа зі сторінки звіту.