Предпосылки
- Code Quality включено, см. Включение GitHub Code Quality.
Просмотр полного бэклога результатов качества кода
- Перейдите на Security and quality вкладку вашего репозитория.
- Нажмите, чтобы развернуть Качество кода, затем нажмите Стандартные выводы.
Кроме того, если вы хотите просмотреть результаты на основе искусственного интеллекта для последних измененных файлов, см. раздел AUTOTITLE.
Изучение невыполненной работы по репозиторию
Панель мониторинга "Стандартные выводы" отображает все результаты, найденные анализом CodeQL в ветви репозитория по умолчанию. Это представление помогает визуализировать всю невыполненную работу по получению качественных результатов и расставить приоритеты в работе по устранению конкретных типов проблем.
Обзор, расположенный в верхней части страницы, обобщает удобство обслуживания и надежность кодовой базы.
Под обзором отображается полный список результатов с заголовком с фильтрами, которые можно использовать, чтобы сосредоточиться на определенном наборе результатов. В результате получаются:
- Сгруппировано по правилу, которое обнаружило каждую находку
- Внутри каждого правила, упорядоченного по пути к файлу в алфавитном порядке
Изучите результаты, развернув правило, чтобы получить список затронутых файлов, и щелкнув имя правила, чтобы просмотреть полные сведения о результатах.
Интерпретация показателей и метрик
Результаты оценки качества кода всегда следует интерпретировать в контексте репозитория. Рассмотрим пример.
- Небольшие репозитории или репозитории с небольшим количеством кода, написанного на поддерживаемых языках, обычно имеют мало результатов и хороших показателей.
- Репозитории с большим количеством созданного кода могут иметь множество результатов обслуживания, уменьшая оценку для обслуживания. Это не проблема, если исходный код сам по себе пригоден для поддержки.
- Большие репозитории с большим количеством кода на полностью поддерживаемом языке часто имеют много результатов, даже если большая часть кода имеет хорошие стандарты удобства обслуживания и надежности.
Дополнительные сведения о метриках и о том, как вычисляются оценки, см. в разделе Справочник по метрикам и оценкам.
Дальнейшие шаги
- Исправьте результаты качества в ветви по умолчанию и повысить удобство обслуживания и оценку надежности для репозитория. См . раздел AUTOTITLE.
- Чтобы в репозитории не накапливалось больше проблем с качеством кода, установите пороговое значение качества для запросов на вытягивание с помощью наборов правил. См . раздел AUTOTITLE.