Категорії оцінювання

Інженерна якість

Категорія «Інженерна якість» — CI, тести, лінтинг та практика документування. Вага: 20% індексу здоров'я inspect.software.

Методологія v1.13.0Оновлено 2026-07-13

Інженерна якість вимірює, чи наявні базові інженерні та документаційні практики: безперервна інтеграція, автоматизовані тести, дисципліна лінтингу й форматування та документація, з якої новачок справді може вчитися. Це практики, що роблять зміни безпечними — для людей-контриб'юторів і, дедалі частіше, для ШІ-агентів для кодування.

Категорія має вагу 20% загального індексу здоров'я.

Метрики цієї категорії

МетрикаВага в категоріїВага в загальному індексі
Інженерні практики60%12%
Документація40%8%

Інженерні практики — це зважений контрольний список доказів гігієни: процеси CI, набір тестів, конфігурація лінтера, pre-commit-хуки та .editorconfig. Документація вимірює, чи пояснює себе проєкт: README, каталог або сайт документації, опис репозиторію, теми та wiki.

Що ця категорія вимірює свідомо

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

Як читати значення категорії

  • Низьке значення тут рідко бреше: відсутність CI та відсутність тестів — видимі факти, а не оцінкові судження.
  • Високе значення означає, що риштування якості на місці. Воно не засвідчує, що код усередині добрий — див. сигнали, а не гарантії.
  • Документація важить 40%: добре протестований проєкт, який нічого не пояснює новачкам, вимірно менш придатний до впровадження, і категорія це відображає.

Як покращити Інженерну якість

  • Додати CI, що запускає набір тестів на кожен push і pull request — два найвагоміші компоненти в інженерних практиках.
  • Закомітити конфігурацію лінтера та форматера; додати pre-commit-хуки та .editorconfig для повного балу.
  • Вести справжній README, каталог docs/ або сайт документації, опис репозиторію й теми — кожен є окремо зваженим компонентом документації.

Дивіться також: готовність до ШІ · індекс здоров'я