Добавление пользовательских инструкций для GitHub Copilot

О пользовательских инструкциях для GitHub Copilot

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

Необходимые компоненты

• Файл пользовательских инструкций (см. приведенные ниже инструкции).

• Параметр "Использовать файлы инструкций" (VS Code) или включение настраиваемых инструкций (Visual Studio) в параметрах. См. раздел "Включение или отключение пользовательских инструкций" далее в этой статье.

  Note

  Параметр включен по умолчанию в VS Code и отключен по умолчанию в Visual Studio.

Создание пользовательского файла инструкций

1. В корневом каталоге репозитория создайте файл с именем .github/copilot-instructions.md.

   Создайте каталог, .github если он еще не существует.

2. Добавьте инструкции по естественному языку в файл в формате Markdown.

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

Примеры инструкций

Этот пример файла содержит три инструкции .github/copilot-instructions.md , которые будут добавлены во все вопросы чата.

We use Bazel for managing our Java dependencies, not Maven, so when talking about Java packages, always give me instructions and code samples that use Bazel.

We always write JavaScript with double quotes and tabs for indentation, so when your responses include JavaScript code, please follow those conventions.

Our team uses Jira for tracking items of work.

Написание эффективных пользовательских инструкций

Инструкции, добавляемые в .github/copilot-instructions.md файл, должны быть короткими, автономными операторами, которые добавляют контекст или соответствующие сведения для дополнения вопросов чата пользователей.

Следующие типы инструкций вряд ли будут работать должным образом и могут вызвать проблемы с другими областями данных Copilot:

• Запросы на ссылки на внешние ресурсы при разработке ответа
• Инструкции по ответу в определенном стиле
• Запросы всегда отвечать на определенный уровень детализации

Поэтому следующие инструкции вряд ли будут иметь предполагаемый результат:

Always conform to the coding styles defined in styleguide.md in repo my-org/my-repo when generating code.

Use @terminal when answering questions about Git.

Answer all questions in the style of a friendly colleague, using informal language.

Answer all questions in less than 1000 characters, and words of no more than 12 characters.

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

Инструкции в .github/copilot-instructions.md файле доступны для использования Copilot Chat сразу после сохранения файла. Полный набор инструкций будет автоматически присоединен к запросам, которые вы отправляете в представлении Copilot Chat или в встроенном чате, в VS Code и Visual Studio.

Пользовательские инструкции не отображаются в представлении чата или встроенном чате, но вы можете убедиться, что они используются Copilot путем просмотра списка ссылок ответа. Если пользовательские инструкции были добавлены в запрос, отправленный в модель, .github/copilot-instructions.md файл будет указан в виде ссылки. Чтобы открыть файл, щелкните ссылку.

Включение или отключение пользовательских инструкций

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

В VS Code

1. Откройте редактор параметров с помощью команды сочетания клавиш +(Mac) / CTRL+ (Linux/Windows).
2. Введите instruction file в поле поиска.
3. Установите или снимите флажок в разделе "Создание кода: используйте файлы инструкций".

В Visual Studio

1. В строке меню Visual Studio в разделе "Сервис" нажмите кнопку " Параметры".

   

2. В диалоговом окне "Параметры" введите custom instructions в поле поиска.

3. Установите или снимите флажок ( предварительная версия) Включите пользовательские инструкции для загрузки из файлов github/copilot-instructions.md и добавленных в запросы.