О качестве кода на GitHub

Обзор

          GitHub Code Quality Это помогает убедиться, что ваша кодовая база надёжна, поддерживаемая и эффективная. Будь то создание новой функции, снижение технической задолженности или отчётность о состоянии репозитория, Code Quality программа предоставляет практические инсайты и автоматизированные исправления, чтобы вы могли эффективно улучшать и поддерживать состояние кода вашего репозитория.

Ключевые функции и преимущества

С помощью Code Quality:

• Выявляйте риски и возможности для качества кода в запросах на вытягивание и с помощью сканирования репозитория.
• Прочитайте чёткие объяснения находок и применяйте автофиксы с помощью одного кликаCopilot.
• Используйте панели мониторинга репозитория для отслеживания показателей надежности и удобства обслуживания, выявления областей, требующих внимания, и определения приоритетов для исправления.

•         **Отслеживайте панели управления организации**, чтобы быстро понять состояние кода ваших репозиториев и определить, какие репозитории стоит исследовать дальше.
  

• Настройте наборы правил для запросов на вытягивание, чтобы обеспечить соблюдение стандартов качества кода и заблокировать изменения, которые не соответствуют вашим критериям.
• Легко назначьте работы по восстановлению , Copilot облачный агент если у вас есть Copilot лицензия.

Доступность и стоимость использования

          GitHub Code Quality доступна для репозиториев, принадлежащих организациям, на GitHub Team и GitHub Enterprise Cloud планах.

          GitHub Code Quality Во время публичного предварительного просмотра не будет выставлен счет. Однако Code Quality сканирование занимает GitHub Actions несколько минут. См [. раздел AUTOTITLE](/billing/concepts/product-billing/github-code-quality).

Поддерживаемые языки

          Code Quality выполняет анализ на основе правил следующих языков с использованием CodeQL:

• C#

• Go

• Ява

• JavaScript

• Питон

• Руби

• Машинописный текст

          Code Quality также выполняет анализ на базе ИИ, результаты которых отображаются отдельно на панели управления репозитория "**Выводы ИИ**" В отличие от анализа на CodeQL основе правил, который сканирует всю кодовую базу и pull requests, этот анализ на базе искусственного интеллекта рассматривает только файлы, недавно отправленные на стандартную ветку, и может выявлять проблемы на языках, выходящих за пределы вышеуказанных. Дополнительные сведения см. в разделе [AUTOTITLE](/code-security/code-quality/responsible-use/code-quality).
  

Где появятся результаты?

После включения Code Quality репозитория вы увидите CodeQL сканы для:

• Каждый новый запрос на вытягивание, открытый в ветке по умолчанию
• Все существующие запросы на вытягивание в ветвь по умолчанию при их обновлении, что запускает новый запуск тестов CI
• Вся кодовая база на ветке по умолчанию на момент и дату, показанные на странице настроек "Качество кода"

Кроме того, вы увидите анализ всех последних отправок в ветвь по умолчанию с помощью искусственного интеллекта.

Результаты запроса на вытягивание

Когда CodeQL вы находите проблемы с правилами в pull requests, вы увидите комментарии от github-code-quality[бот]. По возможности в каждом комментарии будет Автофикс второго пилота содержаться предложение по решению проблемы. См . раздел AUTOTITLE.

Результаты ветви по умолчанию

          Code Quality Результаты на ветке по умолчанию отображаются на страницах «Качество кода» во **<svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-shield" aria-label="shield" role="img"><path d="M7.467.133a1.748 1.748 0 0 1 1.066 0l5.25 1.68A1.75 1.75 0 0 1 15 3.48V7c0 1.566-.32 3.182-1.303 4.682-.983 1.498-2.585 2.813-5.032 3.855a1.697 1.697 0 0 1-1.33 0c-2.447-1.042-4.049-2.357-5.032-3.855C1.32 10.182 1 8.566 1 7V3.48a1.75 1.75 0 0 1 1.217-1.667Zm.61 1.429a.25.25 0 0 0-.153 0l-5.25 1.68a.25.25 0 0 0-.174.238V7c0 1.358.275 2.666 1.057 3.86.784 1.194 2.121 2.34 4.366 3.297a.196.196 0 0 0 .154 0c2.245-.956 3.582-2.104 4.366-3.298C13.225 9.666 13.5 8.36 13.5 7V3.48a.251.251 0 0 0-.174-.237l-5.25-1.68ZM8.75 4.75v3a.75.75 0 0 1-1.5 0v-3a.75.75 0 0 1 1.5 0ZM9 10.5a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z"></path></svg> Security and quality** вкладке репозитория:

* ** Стандартные выводы ** показывает результаты CodeQL анализа качества. См . раздел AUTOTITLE. * ** Выводы ИИ ** показывает результаты анализа файлов с помощью искусственного интеллекта, недавно отправленных в ветку по умолчанию. См . раздел AUTOTITLE.

Информация о сканировании

Каждый CodeQL анализ будет использовать GitHub Actions минуты и отображаться на вкладке «Действия » репозитория как запуск динамического рабочего процесса «Качество кода».

Дальнейшие шаги

•         **Для вашего репозитория:** Включите Code Quality , чтобы начать получать результаты. См [. раздел AUTOTITLE](/code-security/how-tos/maintain-quality-code/enable-code-quality).
  

•         **Для вашего предприятия:** Убедитесь, что репозитории в вашем бизнесе могут поддерживать Code Quality. См [. раздел AUTOTITLE](/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/allow-github-code-quality-in-enterprise).