Skip to main content

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

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

Note

  • Эта функция в настоящее время находится в public preview и подлежит изменению.

  • Пользовательские инструкции в настоящее время поддерживаются для Copilot Chat в Visual Studio, VS Code и на веб-сайте GitHub .

    Эта версия этой статьи предназначена для использования пользовательских инструкций репозитория в Visual Studio. Щелкните приведенные выше вкладки для инструкций по использованию пользовательских инструкций в других средах.

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

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

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

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

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

  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 или в встроенном чате.

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

Снимок экрана: всплывающее окно "Ссылки" с выделенным файлом "copilot-instructions.md" с темным оранжевым контуром.

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

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

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

    Снимок экрана: панель меню Visual Studio . Развернуто меню "Сервис", а элемент "Параметры" выделен оранжевым контуром.

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

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