Обзор кода GitHub Copilot

Узнайте, как Copilot может просматривать запросы на вытягивание.

В этой статье

Введение

GitHub Copilot может просматривать код и предоставлять отзывы. По возможности Copilotотзыв включает предлагаемые изменения, которые можно применить с помощью нескольких щелчков мыши.

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

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

В этой статье представлен обзор Проверка кода Copilot. Инструкции по запросу проверки кода из Copilotсм. в разделе Использование проверки кода GitHub Copilot.

Availability

Проверка кода Copilot поддерживается в:

  • GitHub.com
  • GitHub Mobile
  • VS Code
  • Visual Studio
  • Xcode
  • Идентификаторы JetBrains

Проверка кода Copilot — это премиум-функция, доступная с планами Copilot Pro, Copilot Pro+, Бизнес Copilot и Копилот Энтерпрайз. См . планы Copilot.

Если вы получаете Copilot из организации, чтобы запросить проверка запроса на вытягивание от Copilot на GitHub.com или GitHub Mobile, Проверка кода Copilot параметр должен быть включен в параметрах политики Copilot для организации. См . раздел AUTOTITLE.

Исключённые файлы

Файлы управления зависимостями (такие как package.json и Gemfile.lock) и некоторые другие типы файлов (например, лог-файлы и SVG) исключены из Проверка кода Copilot. Если вы включите любой из этих файлов в pull request, Проверка кода Copilot не будет учитывать файл при проведении проверки. Аналогично, использование Проверка кода Copilot в одном из этих файлов в вашем IDE не генерирует комментарии к отзывам.

Дополнительные сведения см. в разделе Файлы, исключённые из Проверка кода GitHub Copilot.

Новые инструменты (общедоступная предварительная версия) в проверке кода GitHub Copilot

Примечание.

  • Функция Условия лицензии GitHub Pre-release применяется к использованию этого продукта.
  • Эти инструменты включаются автоматически для планов GitHub Copilot Pro или GitHub Copilot Pro+.
  • Если вы получаете подписку Copilot из организации, вы сможете участвовать только в public preview на веб-сайте GitHub , если владелец вашей организации или предприятия включил Copilot в GitHub.com > принять участие в предварительной версии функций на странице политик GitHub Copilot политик организации или предприятия. См. раздел [AUTOTITLE и Управление политиками и функциями для GitHub Copilot в организации](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-enterprise-policies).

Проверка кода Copilot имеет несколько новых инструментов, которые находятся в public preview и могут быть изменены.

  •         **Полный сбор контекста проекта** для предоставления более конкретных, точных и контекстуально зависимых обзоров кода.

  •         **Поддержка инструментов статического анализа, таких как CodeQL, ESLint и PMD** , чтобы обеспечить более высокосигнальные и последовательные результаты по безопасности и качеству.

  •         **Возможность передавать предложения в Агент кодирования Copilot** для автоматического создания нового запроса pull на вашу ветку с применением предложенных исправлений.

Для использования и GitHub Actions в вашей организации или предприятии не обязательно включать%{ data variables.copilot.copilot_code-review- }.

В случае, если GitHub Actions недоступен или если рабочие процессы Actions, используемые Проверка кода Copilot, не работают, проверки все равно будут создаваться, но без дополнительных функций, предоставляемых новые инструменты в обзоре кода Copilot.

Примечание.

public preview включает бесплатные минуты действий для новые инструменты в обзоре кода Copilot.

Плата за использование будет взиматься, когда функция станет общедоступной.

Ежемесячная квота проверки кода

Каждый раз, когда Copilot просматривает pull request или код в вашем IDE, ваша ежемесячная квота премиум-запросов Copilot уменьшается на один.

Если репозиторий настроен для автоматического запроса на проверку кода из Copilot для всех новых запросов на вытягивание, использование запроса класса Premium применяется к квоте автора запроса на вытягивание. Если запрос на вытягивание создается GitHub Actions или ботом, использование будет применяться к пользователю, который активировал рабочий процесс (если это возможно), или к указанному владельцу выставления счетов.

Если вы достигнете ежемесячной квоты, вы не сможете получить проверку кода из Copilot до сброса квоты, если только вы не обновите план Copilot или включите дополнительные запросы уровня "Премиум".

Использование модели

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

Примечание.

Проверка кода Copilot может использовать модели, которые не включены на странице параметров "Модели" вашей организации. Страница настроек "Модели" контролирует только Копилот Чат.

Поскольку Проверка кода Copilot является общедоступным, все использование модели будет регулироваться общедоступными условиями. См . раздел AUTOTITLE.

Предоставление инструкций для проверок кода Copilot

Вы можете настроить проверки, создаваемые Copilot путем предоставления пользовательских инструкций. Это помогает Copilot просматривать код таким образом, чтобы соответствовать стандартам кодирования, инструментам и методикам вашей команды. См. раздел [AUTOTITLE и Добавление пользовательских инструкций репозитория для GitHub Copilot](/copilot/how-tos/configure-custom-instructions/add-organization-instructions).

Проверка проверок кода Copilot

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

Дополнительные сведения см. в разделе Ответственное использование проверки кода GitHub Copilot.

О автоматических проверка запроса на вытягивание

По умолчанию Copilot проверяет только запрос на вытягивание, если он назначен запросу на вытягивание таким же образом, как вы назначите рецензента человека. Тем не менее

  • Отдельные пользователи в плане Copilot Pro или Copilot Pro+ могут настроить Copilot для автоматической проверки всех создаваемых запросов на вытягивание.
  • Владельцы репозитория могут настроить Copilot для автоматической проверки всех запросов на вытягивание в репозитории, созданных пользователями с доступом к Copilot.
  • Владельцы организации могут настроить Copilot для автоматической проверки всех запросов на вытягивание в некоторых или всех репозиториях в организации, где запрос на вытягивание создается пользователем Copilot.

Активация автоматического проверка запроса на вытягивание

Триггеры для автоматической проверки кода зависят от параметров конфигурации:

  •         **Базовый параметр**:
    • При создании запроса на вытягивание в виде запроса на вытягивание open.
    • При первом переключении запроса на вытягивание "Черновик" переключится на "Открыть".
  •         **Просмотрите новые push-уведомления**:
    • Каждый раз, когда новая фиксация отправляется в запрос на вытягивание.
  •         **Просмотрите черновик запросов** на вытягивание:
    • Запросы на вытягивание автоматически проверяются, пока они по-прежнему являются черновиками, прежде чем переключаться на "Открыть".

Примечание.

Если Copilot не настроено для проверки каждой отправки на запрос на вытягивание, запрос на вытягивание будет проверяться только один раз. Если вы вносите изменения в запрос на вытягивание после автоматической проверки и хотите, чтобы Copilot повторно просмотрите запрос на вытягивание, вы можете запросить этот запрос вручную. Для этого нажмите кнопку рядом с именем Copilotв меню "Рецензенты ".

Ограничения на автоматические проверка запроса на вытягивание

Проверка кода Copilot — это функция уровня "Премиум" с ежемесячной квотой на человека. Когда Copilot выполняет автоматическую проверку, он использует один запрос класса Premium из квоты пользователя, создавшего запрос на вытягивание. Дополнительные сведения см. в разделе Обзор кода GitHub Copilot.

Настройка автоматических проверка запроса на вытягивание

Дополнительные сведения о настройке Copilot для автоматической проверки новых запросов на вытягивание см. в разделе Настройка автоматической проверки кода с помощью GitHub Copilot.

О инструментах статического анализа

Вы можете включить инструменты статического анализа в Проверка кода Copilot, чтобы улучшить их способность выявлять и исправлять проблемы. Доступные средства: * CodeQL: Движок анализа кода, который выявляет уязвимости безопасности. Для получения дополнительной информации см. раздел About CodeQL. * ESLint: Линтер, разработанный специально для JavaScript. Для получения дополнительной информации см. раздел «Основные концепции » в документации ESLint. * PMD: Статический анализатор кода, ориентированный на Java и Apex, но также поддерживающий многие другие языки. Для получения дополнительной информации смотрите документацию PMD.

Если у вас есть доступ к новые инструменты в обзоре кода Copilot, CodeQL включен по умолчанию, а ESLint и PMD отключены. Кроме того, если у вас есть доступ к наборам правил, вы можете изменить выбранные инструменты. См . раздел AUTOTITLE.

Получение подробной обратной связи о качестве кода для всего репозитория

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

Дополнительные материалы

  •         [AUTOTITLE](/copilot/how-tos/agents/copilot-code-review/using-copilot-code-review)