Ознайомтеся з функціями огляду коду GitHub Copilot

Завершено

GitHub Copilot може переглянути ваш код і надати відгуки.

Огляд коду GitHub Copilot у Visual Studio Code підтримує два типи перевірки:

  • Рецензування вибору: виділіть код і попросіть початкового рецензування.
  • Перегляд змін. Запитайте більш глибокий огляд усіх змін.

Поточні функції та доступність двох типів перевірки зведено в таблиці нижче.

Функція Перегляд виділеного фрагмента Перегляд змін
Доступно у Visual Studio Code Visual Studio Code та вебсайт GitHub
Преміум/стандартна функція Стандартна функція, доступна для всіх абонентів GitHub Copilot Преміум-функція. Доступно з планами GitHub Copilot Pro, GitHub Copilot Pro+, GitHub Copilot Business та GitHub Copilot Enterprise. Застосовується щомісячна квота для кожного користувача.
Опис Початковий огляд виділеного розділу коду з відгуками та пропозиціями Глибше перегляд усіх змін
Підтримка мови Усі C, C#, C++, Go, Java, JavaScript, Kotlin, Markdown, Python, Ruby, Swift, TypeScript.
Підтримка індивідуальних рекомендацій для кодування Ні Так

Щомісячна квота на перегляд коду

Огляд змінює тип огляду коду GitHub Copilot — це преміум-функція з місячною квотою на людину. Квота наразі активна.

Коли ви призначаєте GitHub Copilot як рецензера для pull request, один преміум-запит віднімається з вашої щомісячної квоти щоразу, коли GitHub Copilot залишає коментарі до pull request.

Якщо репозиторій налаштований на автоматичний запит перегляду коду від GitHub Copilot для всіх нових pull request, використання преміум-запиту застосовується до квоти автора pull request. Якщо pull request створено GitHub Actions або ботом, використання застосовується до користувача, який запустив робочий процес (якщо його можна ідентифікувати), або до призначеного власника білінгу.

Коли ви досягнете щомісячної квоти, ви не зможете отримати перегляд коду від GitHub Copilot, доки ваша квота не скине — якщо тільки ви не оновите свій план GitHub Copilot або не увімкнете більше преміум-запитів.

Попередження

GitHub Copilot не гарантує виявлення всіх проблем у pull request, і іноді робить помилки. Завжди ретельно перевіряйте відгуки GitHub Copilot і доповнюйте GitHub Copilot зворотний зв'язок людським відгуком.

Використання функцій перевірки коду

GitHub Copilot може допомогти з переглядом вашого коду — або для блоку коду, який ви обираєте в редакторі, або для всіх змін, включених у pull request (потрібне розширення GitHub Pull Requests).

Перегляд вибраного блоку коду в редакторі коду

Розумна дія Review надає спосіб перегляду та аналізу вашого коду. Він допоможе визначити області для вдосконалення, запропонувати оновлення для рефактоторування та надати рекомендації щодо практичних порад. Пропозиції, створені функцією перевірки коду, допомагають підвищити якість, надійність, продуктивність і безпеку коду.

  1. Відкрийте код у редакторі.

  2. Виберіть код, який потрібно переглянути.

  3. Клацніть правою кнопкою миші на вибраному коді, а потім виберіть Generate > Code Review.

    Агент перевірки коду створює рецензування приміток на панелі COMMENTS (під редактором коду) і відображає рекомендовані оновлення в тексті в редакторі коду.

    Нотатка

    Контекстне меню Visual Studio Code для GitHub Copilot активно оновлюється. Розумна дія Review може з'являтися на верхньому рівні контекстного меню (поруч із Explain), а не в розділі Generate Code. Якщо опція Review недоступна в контекстному меню, ви можете виконати ту ж дію, вибравши свій код і ввівши запит на кшталт «переглянути цей код» безпосередньо у перегляді чату.

  4. Перегляньте рекомендації та застосуйте або скасуйте оновлення.

    Скріншот із коментарем до огляду коду з запропонованою зміною коду та кнопками Apply і Discard.

    Де це можливо, відгуки Copilot містять запропоновані зміни в коді. Використовуйте «Подати заявку і перейти до наступного », щоб прийняти пропозицію, або «Відхилити і перейти до наступного », щоб відхилити її. Внесені зміни не фіксуються автоматично.

Перегляд усіх змін у кодуванні

Функція GitHub Copilot Code Review дозволяє переглядати всі поетапні або неетаповані зміни у вашій кодовій базі. Він допоможе визначити області для вдосконалення, запропонувати оновлення для рефактоторування та надати рекомендації щодо практичних порад. Пропозиції, створені функцією перевірки коду, допомагають підвищити якість, надійність, продуктивність і безпеку коду.

  1. У Visual Studio Code переключимося на режим контролю версії.

  2. Щоб запросити перегляд ваших непоетапних змін, наведіть курсор миші на CHANGES, а потім виберіть кнопку GitHub Copilot Code Review - Uncommitted Changes.

    скріншот, що показує кнопку GitHub Copilot Code Review у режимі контролю версії.

  3. Чекайте, поки GitHub Copilot перегляне ваші зміни. Зазвичай це займає менше 30 секунд.

  4. Якщо у GitHub Copilot є якісь коментарі, вони будуть показані в рядку у вашому файлі та у вкладці «Проблеми».

    Де це можливо, відгуки Copilot містять запропоновані зміни в коді. Використовуйте «Подати заявку і перейти до наступного », щоб прийняти пропозицію, або «Відхилити і перейти до наступного », щоб відхилити її. Внесені зміни не фіксуються автоматично.

Налаштуйте перегляд коду за допомогою рекомендацій з кодування

Ви можете налаштувати, як Copilot переглядає ваш код, додаючи власні інструкції до свого репозиторію. Це підтримується для типу перегляду змін .

Вкажіть власні інструкції на рівні репозиторію у файлі .github/copilot-instructions.md . Приклад.

When performing a code review, focus on readability and avoid nested ternary operators.
When performing a code review, flag any use of hardcoded credentials.

Ви також можете створювати інструкції, специфічні для шляху, у файлах .github/instructions/**/*.instructions.md, які Copilot використовує лише при перегляді файлів, що відповідають заданому шляху.

Нотатка

Огляд коду Copilot читає лише перші 4 000 символів будь-якого власного файлу інструкцій. Інструкції понад цей ліміт не впливають на отримані відгуки.

Зведення

GitHub Copilot може переглянути ваш код і надати відгуки. Огляд коду GitHub Copilot у Visual Studio Code підтримує два типи перевірки: вибір рецензії та перегляд змін. Розумна дія Review надає спосіб перегляду та аналізу вибраного коду. Він допоможе визначити області для вдосконалення, запропонувати оновлення для рефактоторування та надати рекомендації щодо практичних порад. Функція GitHub Copilot Code Review надає спосіб перегляду поетапних або неетапних змін за допомогою режиму контролю версії Visual Studio Code.