Примечание.
GitHub Code Quality в настоящее время находится в public preview и может быть изменен. Во время public preview, Code Quality не будут оплачиваться, хотя Code Quality сканирование займет GitHub Actions минут.
Предпосылки
- Code Quality включено, см. AUTOTITLE.
Просмотр полного бэклога результатов качества кода
- Перейдите на вкладку «Безопасность» вашего репозитория.
- Нажмите, чтобы развернуть Качество кода, затем нажмите Стандартные выводы.
Кроме того, если вы хотите просмотреть результаты на основе искусственного интеллекта для последних измененных файлов, см. раздел AUTOTITLE.
Изучение невыполненной работы по репозиторию
Панель управления "Стандартные выводы" показывает все результаты, найденные с помощью анализа CodeQL в ветке репозитория по умолчанию. Это представление помогает визуализировать всю невыполненную работу по получению качественных результатов и расставить приоритеты в работе по устранению конкретных типов проблем.
Обзор, расположенный в верхней части страницы, обобщает удобство обслуживания и надежность кодовой базы.
Под обзором отображается полный список результатов с заголовком с фильтрами, которые можно использовать, чтобы сосредоточиться на определенном наборе результатов. В результате получаются:
- Сгруппировано по правилу, которое обнаружило каждую находку
- Внутри каждого правила, упорядоченного по пути к файлу в алфавитном порядке
Изучите результаты, развернув правило, чтобы получить список затронутых файлов, и щелкнув имя правила, чтобы просмотреть полные сведения о результатах.
Интерпретация оценок и метрик
Результаты оценки качества кода всегда следует интерпретировать в контексте репозитория. Рассмотрим пример.
- Небольшие репозитории или репозитории с небольшим количеством кода, написанного на поддерживаемых языках, как правило, имеют мало результатов и хорошие рейтинги.
- Репозитории с большим количеством сгенерированного кода могут иметь много результатов обслуживания, что снижает рейтинг удобства обслуживания. Это не проблема, если исходный код сам по себе пригоден для поддержки.
- Большие репозитории с большим количеством кода на полностью поддерживаемом языке часто имеют много результатов, даже если большая часть кода имеет хорошие стандарты удобства обслуживания и надежности.
Чтобы узнать больше о метриках и способе их расчёта, смотрите АВТОЗАГОЛОВОК.
Дальнейшие шаги
- Исправьте результаты проверки качества в ветви по умолчанию и улучшите удобство обслуживания и надежность репозитория. См . раздел AUTOTITLE.
- Чтобы в репозитории не накапливалось больше проблем с качеством кода, установите пороговое значение качества для запросов на вытягивание с помощью наборов правил. См . раздел AUTOTITLE.