Примененные методы GitHub Copilot

Завершено

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

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

Расширенные задачи с помощью GitHub Copilot

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

Исправление с помощью встроенного чата

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

Например, предположим, что вы работаете над проектом Python и открываете файл со следующим кодом, который содержит ошибку в нем. Чтобы попробовать пример самостоятельно, сначала создайте файл с именем file.txt в каталоге, из которого вы запустите код, и добавьте в него короткую строку текста.

with open("file.txt", "r") as file:
    # Read the file and print the content
    contents = file.read

Выберите код, а затем нажмите клавиши CTRL+I на Windows или Command+I в macOS или выберите Chat>. Если сочетание клавиш вместо этого открывает Ask in Chat, файл является частью активного сеанса редактирования чата, поэтому используйте файл за пределами этого сеанса. Попросите GitHub Copilot исправить код:

Fix the selected code so it reads the file contents and prints them.

Убедитесь, что предложение Copilot устраняет фактическую ошибку. Выражение file.read ссылается на метод, не вызывая его, поэтому contents содержит метод, а не текст файла. Вызовите file.read(), чтобы получить содержимое, а затем выведите возвращённое значение. В имени метода нет опечатки. Исправленный код выглядит следующим образом:

with open("file.txt", "r") as file:
    contents = file.read()
    print(contents)

При выполнении исправленного кода он выводит строку текста из file.txt.

Планируйте более крупные изменения

Используйте команду представления /plan чата, если вы хотите проверить подход перед внесением изменений, например запрос на планирование нового маршрута, показанного ранее в этом модуле. Для исправлений, объяснений, создания тестов или документации опишите нужный результат на естественном языке и укажите соответствующий код. Запрос в предыдущем примере делает это: указывает, что должен делать выбранный код, что дает встроенному чату четкую задачу.

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

Укажите соответствующий контекст

Copilot может выполнять поиск проекта по соответствующему коду, но это не означает, что каждый файл включен в каждый запрос. Явным образом прикрепляйте важные файлы. Например, в пространстве кода API погоды, созданном во время установки:

  1. Откройте представление чата и нажмите Ask.

  2. Выберите Добавить контекст, выберите Файлы и прикрепите main.py, weather.json и test_main.py. Убедитесь, что вложения отображаются в запросе.

  3. Задайте следующий вопрос и сравните ответ с вложенными файлами.

    Explain how this API loads weather data and how its routes use the region, city, and month keys. Identify the existing tests. Don't change files.
    

Явный контекст также помогает, когда запрос зависит от нескольких файлов. Представьте, что вам нужно упаковать проект с помощью Dockerfile. Dockerfile — это специальный файл, который должен иметь конкретные инструкции для упаковки проекта. Прежде чем попросить об этом, прикрепите requirements.txt и main.py, чтобы ответ отражал фактические зависимости проекта и код приложения. Затем, выбрав Ask, введите такой запрос:

I need to create a Dockerfile for this project. Using the attached requirements.txt and main.py, can you generate one that will help me package it?

Вы получите ответ, объясняющий шаги по созданию Dockerfile для проекта, а также некоторые пояснения о действиях файла.

Как всегда, если предложения не совсем то, что вы ищете, вы можете переформулировать запрос и быть более конкретным. Например, можно попросить GitHub Copilot использовать определенный шаг при создании Dockerfile:

Help me create a Dockerfile to package this project, but make sure you're using a virtual environment for Python.

Рассматривайте ответ как предложение для проверки, а не как доказательство того, что созданный образ запускается. В этом примере показано, как контекст формирует ответ. Вам не нужно создавать, собирать или развертывать контейнер для этого модуля.

Включите вывод терминала

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

Explain the failure in the test output below. Identify the relevant code and suggest a focused correction.

<paste the test command and its complete output here>

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

Примечание.

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