Изучение результатов качества кода на GitHub в вашей организации

Необходимые условия

• Если ваша компания принадлежит компании, владелец компании должен поддерживать Code Quality вашу организацию. См . раздел AUTOTITLE.
• В вашей организации должны быть включённые Code Quality репозитории. См . раздел AUTOTITLE.

Просмотр информации о качестве кода для вашей организации

Панель мониторинга уровня организации имеет две вкладки:

• На вкладке "Работоспособность" показан моментальный снимок текущего состояния кода вашей организации.
• На вкладке "Тенденции" показано, как открытые результаты изменились в течение выбранного периода времени, чтобы отслеживать ход выполнения и определять репозитории, требующие внимания.

1. Переходите GitHubна главную страницу вашей организации. Например, из https://github.com/settings/organizations.
2. Под названием вашей организации нажмите вкладку Security and quality .
3. В разделе "Аналитика" боковой панели щелкните Качество кода.

Фильтрация данных панели мониторинга

Панель фильтров в верхней части панели мониторинга применяется как к вкладкам "Работоспособность " и " Тенденции ". Фильтровать можно по:

• Оценка надежности
• Оценка доступности обслуживания
• Стандартные выводы
• Выводы ИИ
• Тема
• Team
• Видимость
• Любые пользовательские свойства, определенные для вашей организации

Вы также можете сортировать данные панели мониторинга с помощью элемента управления "Сортировка " в той же панели фильтров.

Просмотр текущего работоспособности кода

На вкладке "Работоспособность" показан моментальный снимок работоспособности кода вашей организации прямо сейчас.

Интерпретация диаграммы распределения баллов

Таблица распределения баллов предоставляет визуальный обзор состояния кода вашей организации. Каждый пузырь представляет собой набор репозиториев с одинаковыми показателями по поддерживаемости и надёжности.

• Положение каждого пузыря демонстрирует общее состояние этих хранилищ. Более высокие пузыри обозначают более высокие показатели поддерживаемости, а пузыри справа — более высокие показатели надёжности.
• Цвет и узор границ пузыря указывают на степень низкого балла для этих репозиториев. Например, пузырь с оценкой "Бедный" в любой категории всегда будет красным с тире границой.
• Размер каждого пузыря отражает количество хранилищ с конкретной комбинацией оценок.

Чтобы увидеть показатели поддерживаемости, надёжности и количества репозиториев, представленных определённым пузырём, наведите курсор на пузырь.

Исследование таблицы репозитория

Под пузырьковой диаграммой находится таблица, в которой перечислены все репозитории вашей организации. Здесь вы можете ознакомиться с результатами качества кода, а также получить более подробную информацию о них.

Вы можете отсортировать таблицу репозитория по возрастающему или убывающему порядку для любого столбца, кликнув по заголовку столбца.

Исследование репозиториев с низким уровнем баллов

1. Чтобы отфильтровать данные панели управления для самых низкоэффективных репозиториев, на диаграмме распределения баллов нажмите на пузырь с наименьшими суммарными оценками.
2. Прокрутите вниз до таблицы репозитория. По умолчанию таблица отсортирована от большинства до самых поздних сканов репозитория, что помогает расставить приоритеты в текущих проблемах с качеством.
3. При необходимости, чтобы определить приоритет репозиториев с наибольшим количеством выводов CodeQL , дважды щелкните Стандартные выводы .
4. Чтобы просмотреть панель управления на уровне репозитория для конкретного репозитория, нажмите на имя репозитория.

Отслеживание тенденций качества с течением времени

На вкладке "Тенденции " показано, как открытые результаты в репозиториях, к которым у вас есть доступ, и которые соответствуют текущим фильтрам, изменились с течением времени, чтобы узнать, имеет ли ваша работа по качеству кода эффект и где сосредоточить внимание на следующем.

1. На панели мониторинга уровня организации перейдите на вкладку "Тенденции ".
2. Используйте раскрывающийся список "Период" , чтобы выбрать диапазон времени: последние 7, 14 или 30 дней.
3. Просмотрите график "Открытие результатов с течением времени", в котором отображается общее количество открытых выводов в применимых репозиториях в течение выбранного периода.
4. При необходимости используйте кнопки над графом для группировки данных по оценке работоспособности или серьезности.
5. Наведите указатель мыши на точку на графе, чтобы увидеть открытое число поиска в течение этого дня.

Общие сведения о трендах

Помните следующее при интерпретации графа:

• График основан на ежедневных моментальных снимках открытых выводов. Если анализ не выполнен в определенный день, то в этот день может не быть точки данных.

• Исторические данные доступны только при Code Quality начале создания моментальных снимков, поэтому доступный диапазон времени может быть изначально ограничен.

• График отслеживает общее количество открытых результатов, а не отдельные результаты, которые открываются или исправлены. Изменение количества не обязательно означает, что разработчики исправили или представили проблемы.

• Включение Code Quality дополнительных репозиториев может увеличить количество поиска, показанное на графе. Увеличение после включения новых репозиториев не обязательно означает, что качество кода снижается.

• Граф отслеживает общее количество открытых результатов для репозиториев, на которых вы сейчас фильтруете. Общее число включает:

  • Новые результаты, представленные изменениями кода или включение анализа качества кода в новых репозиториях
  • Результаты, исправленные в коде или отклоненные пользователями

Определение репозиториев, требующих внимания

Ниже графа тенденций две таблицы помогают определить, какие репозитории требуют внимания в течение выбранного периода времени:

• Большинство улучшенных репозиториев перечисляет репозитории с наибольшим уменьшением открытых результатов за выбранный период времени.
• Репозитории, нуждающиеся в списках улучшений , с наибольшим увеличением открытых результатов в течение выбранного периода времени.

Обе таблицы включают следующие столбцы:

• Репозиторий: имя репозитория.
• Всего открыто: количество открытых выводов для репозитория в конце выбранного периода времени.
• Чистое изменение: как количество открытых поисков для репозитория изменилось за выбранный период времени.
• Отклонено: Сколько выводов было отклонено для репозитория за выбранный период времени.

Количество выводов для репозитория влияет на исправление и отклонение результатов. Панель мониторинга уровня репозитория можно использовать для подтверждения того, что изменилось.

Чтобы исследовать репозиторий, щелкните его имя, чтобы открыть панель мониторинга уровня Code Quality репозитория, где можно просмотреть отдельные результаты и выполнить действия по исправлению.

Дальнейшие действия

Чтобы понять информацию о здоровье кода, доступную на панели управления на уровне репозитория, см. AUTOTITLE.

Если вы планируете включить Code Quality во многих репозиториях, см. раздел GitHub Code Quality Развертывание в масштабе.