Обзор кода GitHub Copilot

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

В этой статье

Введение

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

В этой статье представлен обзор Проверка кода Copilot. Чтобы узнать, как запросить проверку кода у Copilot, см. АВТОЗАГОЛОВОК.

Availability

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

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

Проверка кода Copilot — это премиальная функция, доступная в следующих планах:

  • Copilot Pro
  • Copilot Pro+
  • Бизнес Copilot
  • Копилот Энтерпрайз

См. планы Copilot.

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

Проверка кода Copilot без лицензии Copilot

Члены организации без лицензии Copilot могут использовать Проверка кода Copilot на GitHub.com. Администратор предприятия или владелец организации должен включить его. Эта возможность доступна организациям на планах Бизнес Copilot и Копилот Энтерпрайз .

Возможность проверки кода для пользователей без лицензии

Чтобы разрешить членам организации без лицензии Copilot использовать Проверка кода Copilot, необходимо включить две политики:

  1.        **Платное использование с премиум-запросом**. Сначала включите эту политику. Это позволяет предприятию или организации взимать плату за использование премиум-запросов Проверка кода Copilot.

  2.        **Разрешить участникам без лицензии Copilot использовать Проверка кода Copilot в GitHub.com**. Эта подполитика позволяет Проверка кода Copilot для пользователей без лицензии.

Второй полис обладает следующими характеристиками:

  • Он отключен по умолчанию.
  • Как только эта политика установлена на корпоративном уровне, она становится видимой, но не поддаётся редактированию на уровне организации.
  • Политика очень строгая. Проверка кода Copilot доступен только в репозиториях, где эта политика явно включена.

Как это работает для пользователей без лицензии

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

В репозиториях, где включена автоматическая проверка кода, Copilot автоматически проверяет все pull-запросы. Это происходит независимо от того, есть ли у автора лицензия Copilot.

Проверка кода Copilot для пользователей без лицензии недоступны в IDE.

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

Некоторые типы файлов исключены из Проверка кода Copilot:

  • Файлы управления зависимостями, такие как package.json и Gemfile.lock
  • Файлы журналов
  • SVG-файлы

Если вы включите эти типы файлов в pull request, Проверка кода Copilot не будет просматривать файл.

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

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

Примечание.

  • Функция Условия лицензии GitHub Pre-release применяется к использованию этого продукта.
  • Проверка кода Copilot имеет несколько новых инструментов, которые находятся в public preview и могут быть изменены.

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

Эти новые инструменты автоматически включаются для планов Copilot Pro или Copilot Pro+.

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

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

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

Для использования новые инструменты в обзоре кода Copilot в вашей организации или предприятии не нужно иметь включённые code scanning и GitHub Actions.

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

Примечание.

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

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

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

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

Если репозиторий настроен на автоматический запрос проверки кода у Copilot для всех новых pull request, использование премиум-запроса применяется к квоте автора pull request.

Если pull request создан GitHub Actions или ботом, использование будет применяться к:

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

Что происходит, когда вы достигнете своей нормы

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

Квота для пользователей без лицензии Copilot

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

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

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

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

Примечание.

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

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

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

Copilot не гарантирует обнаружение всех проблем или проблем в pull requeste. Иногда она совершает ошибки. Всегда тщательно проверяйте отзывы Copilot. Дополните отзывы Copilot человеческим обзором.

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

Улучшение знаний Copilot о репозитории

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

Пользовательские инструкции

Это короткие операторы на естественном языке, которые вы пишете и храните в виде одного или нескольких файлов в репозитории. Если вы владелец организации на GitHub, вы также можете задать пользовательские инструкции в настройках вашей организации. Дополнительные сведения см. в разделе Сведения о настройке ответов GitHub Copilot.

Память copilot (public preview)

Если у вас есть план Copilot Pro или Copilot Pro+, вы можете включить Память copilot. Это позволяет Copilot хранить полезные детали, которые они узнали о репозитории. Copilot может использовать эту информацию при просмотре pull requests в этом репозитории. Дополнительные сведения см. в разделе О агентной памяти для GitHub Copilot.

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

По умолчанию Copilot рассматривает pull-запрос только если вы назначите его к нему. Однако вы можете настроить автоматические отзывы.

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

  •         **Владельцы репозиториев** могут настроить Copilot для автоматического просмотра всех pull-запросов в репозитории, созданных людьми с доступом к Copilot.

  •         **Владельцы организаций** могут настроить Copilot для автоматического просмотра всех pull-запросов в некоторых или всех репозиториях организации, где этот запрос создаётся пользователем Copilot.

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

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

  • Базовая обстановка:
    • Когда вы создаёте pull request как «Open» pull request.
    • Первый раз, когда вы переключаете pull-запрос «Draft» на «Open».
  • Обзор новых выпусков:
    • Каждый раз, когда вы запускаете новый коммит в pull request.
  • Просмотр черновиков pull requests:
    • Pull requests автоматически проверяются, пока они ещё черновики, прежде чем вы переключаете их в «Открытый».

Полные инструкции смотрите в разделе AUTOTITLE.

Примечание.

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

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

Включить инструменты статического анализа в Проверка кода Copilot для повышения эффективности выявления и устранения проблем. Доступные средства:

  •         **CodeQL**: Движок анализа кода, который выявляет уязвимости безопасности. Для получения дополнительной информации см. [раздел About CodeQL](/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql#about-codeql).

  •         **ESLint**: Линтер, разработанный специально для JavaScript. См. [основные концепции](https://eslint.org/docs/latest/use/core-concepts/) в документации ESLint.

  •         **PMD**: Статический анализатор кода, ориентированный на Java и Apex. Также поддерживается множество других языков. См. [документацию PMD](https://docs.pmd-code.org/latest/).

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

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

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

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

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