Введение
GitHub Code Quality (public preview) помогает сохранить надежность и удобство обслуживания кода, отображая результаты оценки качества кода в запросах pull и в ветке по умолчанию.
В этом руководстве вы узнаете, как определить и исправить обнаружение качества кода в ветви по умолчанию, что поможет улучшить работоспособность кода репозитория.
Предпосылки
- GitHub Code Quality должны быть включены для вашего репозитория, и у вас должен быть код на поддерживаемом языке. См. раздел AUTOTITLE.
- Если вы включаете GitHub Code Quality впервые, убедитесь, что вы подождали несколько минут после включения, пока завершится сканирование ветви по умолчанию.
Просмотр результатов сканирования для ветви по умолчанию
В репозитории перейдите на вкладкуБезопасность , нажмите Качество кода на левой боковой панели, затем нажмите Стандартные выводы , чтобы открыть панель управления репозитория.
Здесь вы увидите:
-
Оценки надежности иудобства обслуживания базы кода, которые помогают быстро понять работоспособность кода.
-
Список результатов всех проблем с качеством, обнаруженных в ветви по умолчанию, которые сгруппированы по правилам и языкам.
Определите обнаружение, имеющее большое значение
Используйтефильтры панели мониторинга , чтобы определить высокий уровень серьезности («Ошибка» или «Предупреждение»).
Устранение этих проблем окажет наибольшее влияние на рейтинги репозитория.
Изучите детали находки
Щелкните само название правила, чтобы просмотреть подробные сведения о файлах и строках кода, на которые распространяется это правило.
Перейдя в подробное представление, нажмитекнопку Показать больше , чтобы собрать контекст и понять результаты.
Сгенерируйте Copilot Autofix
Справа от выделенной находки нажмите Generate fix.
Просмотрите предложенное исправление и нажмитеОткрыть запрос на вытягивание.
Слияние исправления
Внимательно изучите черновик запроса на вытягивание. Если вас устраивают предложенные изменения и все проверки и тесты пройдены, выполните слияние запроса на вытягивание.
Наблюдайте за изменением метрик
Вернитесь на панель управления Code Quality (вкладкаБезопасность , затем Качество кода, затем Стандартные выводы).
Подождите несколько минут, пока не завершится следующее сканирование — Code Quality сканирования автоматически перезапускаются после каждой отправки в ветку по умолчанию.
Следите за изменением метрик в верхней части панели мониторинга:
-
Количество выводов по «Надежности» или «Ремонтопригодности» должно было уменьшиться.
-
Вашиоценки «Надежность» или «Ремонтопригодность» могли улучшиться, если в исправлении был учтен ряд важных выводов.
Чтобы узнать больше о том, как рассчитываются рейтинги, см.Справочник по метрикам и рейтингам.
Conclusion
Вы успешно использовали Code Quality и Copilot Autofix для улучшения работоспособности кода вашего репозитория!
Работоспособный код проще для понимания, поддержки и расширения, а устранение проблем с качеством кода делает базу кода более надежной, соответствующей требованиям и ускоряет будущую разработку.
Дальнейшие шаги
- Узнайте, как GitHub Code Quality работает с запросами на вытягивание, чтобы предотвратить попадание проблем с качеством кода в ветку по умолчанию. См. раздел AUTOTITLE.
- Оставьте отзыв о GitHub Code Quality вобсуждении сообщества.