Здоров'я спільноти вимірює, чи налаштований репозиторій приймати користувачів і контриб'юторів: стандартні файли, які розповідають новачкові, що це за проєкт, на яких умовах ним можна користуватися та як узяти участь. Ці файли — різниця між кодовою базою та спільнотою.
- Категорія: Спільнота та впровадження (35% у межах категорії)
- Вага в загальному індексі: 6.3%
- Ключ метрики:
community_health
Як обчислюється значення
Зважений контрольний список стандартних файлів, кожен наявний або відсутній (рядок ліцензії може також отримати часткові бали — див. нижче):
| Компонент | Вага |
|---|---|
| README | 22.5 |
| Ліцензія | 22.5 |
| Настанови CONTRIBUTING | 18 |
| Кодекс поведінки | 13.5 |
| Шаблон issue | 7.2 |
| Шаблон PR | 6.3 |
Як виявляється ліцензія
Наявність ліцензії перевіряється один раз, за трьома джерелами, які розглядаються разом: власні метадані ліцензії репозиторію, профіль спільноти GitHub та опублікована, нейтральна щодо інструментів перевірка License від OpenSSF Scorecard. Файл, який бачить будь-яке джерело, вважається наявним — джерела розходяться приблизно на 1% репозиторіїв, і одне недоступне джерело не повинне повідомляти про відсутність ліцензії.
Результатом є один із трьох станів:
| Стан | Значення | Зарахування |
|---|---|---|
| Стандартна | Визнана ліцензія, ідентифікована кодом SPDX | 22.5 |
| Власна | Файл ліцензії наявний, але його текст не є визнаною ліцензією | 16.9 |
| Відсутня | Жодне джерело не знайшло файлу ліцензії | 0 |
Власна ліцензія — це справжня ліцензія, і вона отримує більшу частину ваги. Але не всю: ліцензія, яку автоматизовані інструменти не можуть ідентифікувати, є реальною перешкодою для впровадження, оскільки інструменти політик, корпоративне рецензування та реєстри пакетів спираються на визнані ідентифікатори, а читач не може встановити межі дозволеного, не прочитавши текст самостійно. GitHub позначає цей випадок як NOASSERTION — ліцензія, яку він знайшов, але не зміг класифікувати, що не те саме, що відсутність ліцензії взагалі.
Результат Scorecard залишається компонентом метрики безпеки; тут він є одним із трьох вхідних джерел, показаним просто як License.
Чому ці файли мають вагу
- README та ліцензія несуть основне навантаження. Репозиторій без README непридатний до впровадження; репозиторій без ліцензії юридично неприйнятний у більшості організацій — жоден юридичний відділ не схвалить залежність із невизначеними умовами. Разом вони несуть половину метрики.
- CONTRIBUTING і кодекс поведінки перетворюють випадковий інтерес на сталу участь, яка безпосередньо живить безперервність, вимірювану стійкістю мейнтейнерів.
- Шаблони підвищують якість сигналу вхідних issue та pull request-ів, зменшуючи навантаження на мейнтейнерів під час сортування — невеликий, але реальний чинник оперативності, яку проєкт здатен підтримувати.
Як читати результат
- Контрольний список не залежить від масштабу: тижневий проєкт може досягти 100 ще до першої зірки, а знаменитий проєкт без ліцензії читається помітно неповним. Так і задумано — ця метрика вимірює підготовленість, а не розкрученість.
- Верифікується наявність, а не якість тексту — див. примітку про чесність вимірювання у статті сигнали, а не гарантії.
Як покращити значення
Кожен компонент можна виправити безпосередньо протягом години:
- Написати README, що описує призначення проєкту, встановлення та мінімальний приклад.
- Додати файл
LICENSEіз визнаною ліцензією SPDX. - Додати
CONTRIBUTING.md,CODE_OF_CONDUCT.mdта шаблони issue/PR у.github/.
Це зазвичай метрика, яку найшвидше зрушити в усій методології.
Дивіться також: Спільнота та впровадження · документація