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

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

Tool navigation

В этой статье

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

Введение

Пользовательские инструкции репозитория позволяют предоставлять Copilot с рекомендациями и предпочтениями для конкретного репозитория. Дополнительные сведения см. в разделе О кастомизации ответов GitHub Copilot.

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

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

          VS Code Поддерживает три типа пользовательских инструкций репозитория. Для подробностей о том, какие GitHub Copilot функции поддерживают такие инструкции, см. [AUTOTITLE.](/copilot/concepts/prompting/response-customization?tool=vscode#support-for-repository-custom-instructions-1)

  • Пользовательские инструкции на уровне репозитория, которые применяются ко всем запросам, сделанным в контексте репозитория.

    Они указаны в copilot-instructions.md файле в .github каталоге репозитория. Дополнительные инструкции см. в статье "Создание пользовательских инструкций на уровне репозитория".

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

    Они указываются в одном или нескольких NAME.instructions.md файлах внутри или ниже .github/instructions каталога репозитория. Дополнительные инструкции см. в статье "Создание пользовательских инструкций для конкретного пути".

    Если выбранный вами путь совпадает с работающим файлом Copilot , и существует пользовательский файл инструкций на весь репозиторий, то используются инструкции из обоих файлов.

  • Инструкции агента используются агентами ИИ.

    Вы можете создать один или несколько AGENTS.md файлов, хранящихся в любом месте репозитория. Когда Copilot работает, приоритет будет иметь ближайший AGENTS.md файл в дереве каталогов. Для получения дополнительной информации смотрите репозиторий agentsmd/agents.md.

    Примечание.

    Поддержка AGENTS.md файлов за пределами корня рабочей области в настоящее время по умолчанию отключена. Для подробностей о том, как включить эту функцию, см. раздел «Использовать пользовательские инструкции в VS Code » в VS Code документации.

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

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

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

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

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

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

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

  2. По желанию создайте подкаталоги .github/instructions для организации ваших файлов инструкций.

  3. Создайте один или несколько NAME.instructions.md файлов, где NAME указывается назначение инструкций. Имя файла должно заканчиваться .instructions.md.

  4. В начале файла создайте блок frontmatter, содержащий ключевое applyTo слово. Используйте синтаксис glob, чтобы указать, к каким файлам или каталогам применяются инструкции.

    Например:

    ---
applyTo: "app/models/**/*.rb"
---

    Можно указать несколько шаблонов, разделив их запятыми. Например, чтобы применить инструкции ко всем файлам TypeScript в репозитории, можно использовать следующий блок frontmatter:

    ---
applyTo: "**/*.ts,**/*.tsx"
---

    Примеры Glob:

    • * - все будут совпадать со всеми файлами текущей директории.
    • ** или **/* — все совпадут со всеми файлами во всех каталогах.
    • *.py - будет совпадать со всеми .py файлами текущей папки.
    • **/*.py - будет рекурсивно совпадать со всеми .py файлами во всех каталогах.
    • src/*.py- будет .py совпадать со всеми src файлами в каталоге. Например src/foo.py , и src/bar.pyнетsrc/foo/bar.py.
    • src/**/*.py - будет рекурсивно совпадать со всеми .py файлами в src каталоге. Например, src/foo.py, src/foo/bar.pyи src/foo/bar/baz.py.
    • **/subdir/**/*.py - будет рекурсивно совпадать со всеми .py файлами в любой subdir папке на любой глубине. Например, subdir/foo.py, subdir/nested/bar.py, parent/subdir/baz.py, и deep/parent/subdir/nested/qux.py, но неfoo.py на пути, не содержащем каталога subdir .

  5. Опционально, чтобы предотвратить использование файла либо Copilot облачный агент одним из вариантов Обзор кода Copilot, добавьте excludeAgent ключевое слово в блок фронтматтера. Используйте либо или "code-review"``"cloud-agent".

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

    ---
applyTo: "**"
excludeAgent: "code-review"
---

    Если ключевое excludeAgent слово не включено в передний блок Matterblock, оба Обзор кода Copilot и Copilot облачный агент будут использовать ваши инструкции.

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

Вы успешно добавили в репозиторий пользовательский файл инструкций?

          <a href="https://docs.github.io/success-test/yes.html" target="_blank" class="btn btn-outline mt-3 mr-3 no-underline">
          <span>Да</span></a><a href="https://docs.github.io/success-test/no.html" target="_blank" class="btn btn-outline mt-3 mr-3 no-underline"><span>нет</span></a>

Пользуемые инструкции

Инструкции в файлах доступны для использования Copilot сразу после сохранения файла(ов). Инструкции автоматически добавляются к запросам, которые вы отправляете в Copilot.

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

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

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

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

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

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

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

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

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

  1. На GitHubперейдите на главную страницу репозитория.

  2. Под именем репозитория щелкните Settings. Если вкладка "Параметры" не отображается, выберите раскрывающееся меню и нажмите кнопку "Параметры".

    Снимок экрана: заголовок репозитория с вкладками. Вкладка "Параметры" выделена темно-оранжевым контуром.

  3. В разделе "Код и автоматизация" боковой панели щелкните Copilot, а затем проверка кода.

  4. Переключите параметр "Использовать пользовательские инструкции при проверке запросов на вытягивание" включено или выключение.

Включение и использование файлов запроса

Примечание.

  • Файлы запроса Copilot находятся в public preview и подвергаются изменению. Файлы запросов доступны только в IDE VS Code, Visual Studio и JetBrains. Смотрите АВТОЗАГОЛОВОК.
  • Примеры файлов запросов для определенных языков и сценариев в сообществе см. в репозитории GitHub Copilot Customizations .

Файлы запроса позволяют создавать и совместно использовать повторно используемые инструкции запроса с дополнительным контекстом. Файл запросов — это файл Markdown, хранящийся в вашем рабочем пространстве, который имитирует существующий формат написания запросов в Копилот Чат (например, Rewrite #file:x.ts). В рабочей области может быть несколько файлов запросов, каждый из которых определяет запрос для другой цели.

Включение файлов запроса

Чтобы включить файлы запроса, настройте параметры рабочей области.

  1. Откройте палитру команд, нажав клавиши CTRL++ (Mac).
  2. Введите "Открыть параметры рабочей области (JSON)" и выберите отображаемый параметр.
  3.        `settings.json` В файле добавьте`"chat.promptFiles": true`, чтобы включить `.github/prompts` папку в качестве расположения для файлов запроса. Эта папка будет создана, если она еще не существует.

Создание файлов запроса

  1. Откройте палитру команд, нажав клавиши CTRL++ (Mac).

  2. Введите "запрос" и выберите "Чат: создать запрос".

  3. Введите имя файла запроса, за исключением .prompt.md расширения имени файла. Имя может содержать буквенно-цифровые символы и пробелы, и должно описать назначение сведений о запросе, которые будет содержать файл.

  4. Напишите инструкции по запросу с помощью форматирования Markdown.

    Вы можете ссылаться на другие файлы в рабочей области с помощью ссылок Markdown, например, [index](../../web/index.ts)или с помощью синтаксиса #file:../../web/index.ts . Пути относительны к файлу запроса. Ссылка на другие файлы позволяет предоставить дополнительный контекст, например спецификации API или документацию по продуктам.

Использование файлов подсказки

  1. Внизу Копилот Чат представления нажмите на значок «Прикрепить контекст » ().

  2. В раскрывающемся меню нажмите кнопку "Запрос... и выберите файл запроса, который вы хотите использовать.

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

  4. При необходимости введите дополнительные сведения в поле запроса чата.

    Нужно ли делать это или нет, зависит от содержимого используемого запроса.

  5. Отправьте запрос чата.

Для получения дополнительной информации о файлах запросов см. раздел «Использовать файлы запросов» в Visual Studio CodeVisual Studio Code документации.

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

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

Введение

Пользовательские инструкции репозитория позволяют предоставлять Copilot с рекомендациями и предпочтениями для конкретного репозитория. Дополнительные сведения см. в разделе О кастомизации ответов GitHub Copilot.

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

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

          Visual Studio Поддерживает два типа пользовательских инструкций. Для подробностей о том, какие GitHub Copilot функции поддерживают такие инструкции, см. [AUTOTITLE.](/copilot/concepts/prompting/response-customization?tool=visualstudio#support-for-repository-custom-instructions-2)

  • Пользовательские инструкции на уровне репозитория, которые применяются ко всем запросам, сделанным в контексте репозитория.

    Они указаны в copilot-instructions.md файле в .github каталоге репозитория. Дополнительные инструкции см. в статье "Создание пользовательских инструкций на уровне репозитория".

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

    Они указываются в одном или нескольких NAME.instructions.md файлах внутри или ниже .github/instructions каталога репозитория. Дополнительные инструкции см. в статье "Создание пользовательских инструкций для конкретного пути".

    Если выбранный вами путь совпадает с работающим файлом Copilot , и существует пользовательский файл инструкций на весь репозиторий, то используются инструкции из обоих файлов.

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

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

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

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

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

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

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

  2. По желанию создайте подкаталоги .github/instructions для организации ваших файлов инструкций.

  3. Создайте один или несколько NAME.instructions.md файлов, где NAME указывается назначение инструкций. Имя файла должно заканчиваться .instructions.md.

  4. В начале файла создайте блок frontmatter, содержащий ключевое applyTo слово. Используйте синтаксис glob, чтобы указать, к каким файлам или каталогам применяются инструкции.

    Например:

    ---
applyTo: "app/models/**/*.rb"
---

    Можно указать несколько шаблонов, разделив их запятыми. Например, чтобы применить инструкции ко всем файлам TypeScript в репозитории, можно использовать следующий блок frontmatter:

    ---
applyTo: "**/*.ts,**/*.tsx"
---

    Примеры Glob:

    • * - все будут совпадать со всеми файлами текущей директории.
    • ** или **/* — все совпадут со всеми файлами во всех каталогах.
    • *.py - будет совпадать со всеми .py файлами текущей папки.
    • **/*.py - будет рекурсивно совпадать со всеми .py файлами во всех каталогах.
    • src/*.py- будет .py совпадать со всеми src файлами в каталоге. Например src/foo.py , и src/bar.pyнетsrc/foo/bar.py.
    • src/**/*.py - будет рекурсивно совпадать со всеми .py файлами в src каталоге. Например, src/foo.py, src/foo/bar.pyи src/foo/bar/baz.py.
    • **/subdir/**/*.py - будет рекурсивно совпадать со всеми .py файлами в любой subdir папке на любой глубине. Например, subdir/foo.py, subdir/nested/bar.py, parent/subdir/baz.py, и deep/parent/subdir/nested/qux.py, но неfoo.py на пути, не содержащем каталога subdir .

  5. Опционально, чтобы предотвратить использование файла либо Copilot облачный агент одним из вариантов Обзор кода Copilot, добавьте excludeAgent ключевое слово в блок фронтматтера. Используйте либо или "code-review"``"cloud-agent".

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

    ---
applyTo: "**"
excludeAgent: "code-review"
---

    Если ключевое excludeAgent слово не включено в передний блок Matterblock, оба Обзор кода Copilot и Copilot облачный агент будут использовать ваши инструкции.

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

Вы успешно добавили в репозиторий пользовательский файл инструкций?

          <a href="https://docs.github.io/success-test/yes.html" target="_blank" class="btn btn-outline mt-3 mr-3 no-underline">
          <span>Да</span></a><a href="https://docs.github.io/success-test/no.html" target="_blank" class="btn btn-outline mt-3 mr-3 no-underline"><span>нет</span></a>

Пользуемые инструкции

Инструкции в файлах доступны для использования Copilot сразу после сохранения файла(ов). Инструкции автоматически добавляются к запросам, которые вы отправляете в Copilot.

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

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

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

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

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

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

  1. В строке Visual Studio меню, в разделе «Инструменты», нажмите «Параметры».

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

  2. В диалоговом меню «Опции» введите custom instructions поисковую строку и нажмите Copilot.

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

    Снимок экрана: диалоговое окно "Параметры " Visual Studio с выбранным флажком "Включить настраиваемые инструкции".

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

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

  1. На GitHubперейдите на главную страницу репозитория.

  2. Под именем репозитория щелкните Settings. Если вкладка "Параметры" не отображается, выберите раскрывающееся меню и нажмите кнопку "Параметры".

    Снимок экрана: заголовок репозитория с вкладками. Вкладка "Параметры" выделена темно-оранжевым контуром.

  3. В разделе "Код и автоматизация" боковой панели щелкните Copilot, а затем проверка кода.

  4. Переключите параметр "Использовать пользовательские инструкции при проверке запросов на вытягивание" включено или выключение.

Использование файлов подсказки

Примечание.

  • Файлы запроса Copilot находятся в public preview и подвергаются изменению. Файлы запросов доступны только в IDE VS Code, Visual Studio и JetBrains. Смотрите АВТОЗАГОЛОВОК.
  • Примеры файлов запросов для определенных языков и сценариев в сообществе см. в репозитории GitHub Copilot Customizations .

Файлы запроса позволяют создавать и совместно использовать повторно используемые инструкции запроса с дополнительным контекстом. Файл запросов — это файл Markdown, хранящийся в вашем рабочем пространстве, который имитирует существующий формат написания запросов в Копилот Чат (например, Rewrite #file:x.ts). В рабочей области может быть несколько файлов запросов, каждый из которых определяет запрос для другой цели.

Создание файлов запроса

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

  2. Напишите инструкции по запросу с помощью форматирования Markdown.

    Вы можете ссылаться на другие файлы в рабочей области с помощью ссылок Markdown, например, [index](../../web/index.ts)или с помощью синтаксиса #file:'../../web/index.ts' . Пути относительны к файлу запроса. Ссылка на другие файлы позволяет предоставить дополнительный контекст, например спецификации API или документацию по продуктам.

Для получения дополнительной информации о файлах запросов см. раздел «Использовать файлы запросов» в Visual StudioVisual Studio документации.

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

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

Введение

Пользовательские инструкции репозитория позволяют предоставлять Copilot с рекомендациями и предпочтениями для конкретного репозитория. Дополнительные сведения см. в разделе О кастомизации ответов GitHub Copilot.

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

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

  • Последняя версия Copilot расширения должна быть установлена в вашем IDE JetBrains.

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

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

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

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

Использование страницы параметров

  1. В интегрированной среде разработки JetBrains выберите меню "Файл " (Windows) или имя приложения в строке меню (macOS), а затем нажмите кнопку "Параметры".

           1. В левой боковой панели нажмите **«Инструменты**», нажмите **GitHub Copilot**., затем нажмите **Кастомизации**.

  2. В разделе «Copilot Инструкции» нажмите Workspace или Global , чтобы выбрать, применимы ли пользовательские инструкции к текущему рабочему пространству или ко всем рабочим пространствам.

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

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

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

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

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

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

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

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

  2. Перейдите к соответствующему расположению операционной системы:

    • macOS:/Users/YOUR-USERNAME/.config/github-copilot/intellij/
    • Windows: C:\Users\YOUR-USERNAME\AppData\Local\github-copilot\intellij\

  3. Создайте файл с именем global-copilot-instructions.md в этом каталоге.

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

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

Вы успешно добавили в репозиторий пользовательский файл инструкций?

          <a href="https://docs.github.io/success-test/yes.html" target="_blank" class="btn btn-outline mt-3 mr-3 no-underline">
          <span>Да</span></a><a href="https://docs.github.io/success-test/no.html" target="_blank" class="btn btn-outline mt-3 mr-3 no-underline"><span>нет</span></a>

Пользуемые инструкции

Инструкции в файлах доступны для использования Copilot сразу после сохранения файла(ов). Инструкции автоматически добавляются к запросам, которые вы отправляете в Copilot.

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

Использование файлов подсказки

Примечание.

  • Файлы запроса Copilot находятся в public preview и подвергаются изменению. Файлы запросов доступны только в IDE VS Code, Visual Studio и JetBrains. Смотрите АВТОЗАГОЛОВОК.
  • Примеры файлов запросов для определенных языков и сценариев в сообществе см. в репозитории GitHub Copilot Customizations .

Файлы запроса позволяют создавать и совместно использовать повторно используемые инструкции запроса с дополнительным контекстом. Файл запросов — это файл Markdown, хранящийся в вашем рабочем пространстве, который имитирует существующий формат написания запросов в Копилот Чат (например, Rewrite #file:x.ts). В рабочей области может быть несколько файлов запросов, каждый из которых определяет запрос для другой цели.

При написании инструкций для запросов вы можете обращаться к другим файлам в рабочем пространстве, например [index](../../web/index.ts), используя ссылки Markdown или используя синтаксис #file:../../web/index.ts . Пути относительны к файлу запроса. Ссылка на другие файлы позволяет предоставить дополнительный контекст, например спецификации API или документацию по продуктам.

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

Создание файлов строк с помощью командной строки

  1. Создайте .github/prompts директорию, если она ещё не существует в вашем рабочем пространстве. Этот каталог будет местом размещения ваших файлов запросов.
  2. Создайте файл запросов в .github/prompts каталоге. Имя файла запроса может содержать буквенно-цифровые символы и пробелы и должно описывать цель информации о запросе, которая будет содержаться в файле. Имя файла должно заканчиваться расширением .prompt.md имени файла, например TESTPROMPT.prompt.md, .
  3. Запишите инструкции с помощью форматирования Markdown и сохраните файл.

Создание файлов запросов с помощью страницы настроек

  1. В интегрированной среде разработки JetBrains выберите меню "Файл " (Windows) или имя приложения в строке меню (macOS), а затем нажмите кнопку "Параметры".
  2. В разделе Инструменты, под GitHub Copilot, нажмите Редактировать настройки.
  3. В разделе «Категории настроек» нажмите «Настройки».
  4. В разделе «Файлы запросов» нажмите Workspace, чтобы создать файл запросов в вашем рабочем пространстве.
  5. Введите имя файла запроса, за исключением .prompt.md расширения имени файла. Имя файла запроса может содержать буквенно-цифровые символы и пробелы и должно описывать цель информации о запросе, которая будет содержаться в файле.
  6. Нажмите Ок , чтобы сохранить имя файла запроса.
  7. Запишите инструкции с помощью форматирования Markdown и сохраните файл.

Использование файлов подсказки

  1. В поле ввода чата введите / , а затем имя файла запроса. Например: /TESTPROMPT.

  2. По желанию прикрепить дополнительные файлы для получения дополнительного контекста.

  3. При необходимости введите дополнительные сведения в поле запроса чата.

    Нужно ли делать это или нет, зависит от содержимого используемого запроса.

  4. Отправьте запрос чата.

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

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

Введение

Пользовательские инструкции репозитория позволяют предоставлять Copilot с рекомендациями и предпочтениями для конкретного репозитория. Дополнительные сведения см. в разделе О кастомизации ответов GitHub Copilot.

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

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

  • Последняя версия Copilot расширения должна быть установлена в Xcode.

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

Xcode поддерживает один .github/copilot-instructions.md пользовательский файл инструкций, хранящийся в репозитории.

Вы можете создать пользовательский файл инструкций в своём репозитории через страницу Copilot настроек.

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

  1. Откройте GitHub Copilot приложение для Xcode.
  2. В верхней части окна приложения в разделе "Параметры" нажмите кнопку "Дополнительно".
  3. Справа от "Настраиваемые инструкции" щелкните "Текущая рабочая область" или "Глобальная", чтобы выбрать, применяются ли пользовательские инструкции к текущей рабочей области или ко всем рабочим областям.

Вы успешно добавили в репозиторий пользовательский файл инструкций?

          <a href="https://docs.github.io/success-test/yes.html" target="_blank" class="btn btn-outline mt-3 mr-3 no-underline">
          <span>Да</span></a><a href="https://docs.github.io/success-test/no.html" target="_blank" class="btn btn-outline mt-3 mr-3 no-underline"><span>нет</span></a>

Пользуемые инструкции

Инструкции в файлах доступны для использования Copilot сразу после сохранения файла(ов). Инструкции автоматически добавляются к запросам, которые вы отправляете в Copilot.

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

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

Примечание.

Эта функция сейчас действует public preview и может измениться.

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

Введение

Пользовательские инструкции репозитория позволяют предоставлять Copilot с рекомендациями и предпочтениями для конкретного репозитория. Дополнительные сведения см. в разделе О кастомизации ответов GitHub Copilot.

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

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

  • Последняя версия Copilot расширения должна быть установлена в Eclipse.

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

Eclipse поддерживает два типа пользовательских инструкций репозитория: рабочие области и пользовательские инструкции проекта.

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

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

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

  1. Чтобы открыть Копилот Чат панель, нажмите на Copilot значок () в строке статуса внизу Eclipse.
  2. В меню выберите "Изменить параметры".
  3. В левой панели разверните GitHub Copilot и нажмите «Пользовательские инструкции».
  4. Выберите "Включить инструкции рабочей области".
  5. В разделе «Workspace» в разделе «Set custom instructions to guide Copilotto the code suggestions of the workspace» добавьте инструкции на естественном языке в файл в формате Markdown.

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

  1. В корневом каталоге проекта создайте файл с именем .github/copilot-instructions.md.
  2. Добавьте пользовательские инструкции на естественном языке с помощью формата Markdown.

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

Вы успешно добавили в репозиторий пользовательский файл инструкций?

          <a href="https://docs.github.io/success-test/yes.html" target="_blank" class="btn btn-outline mt-3 mr-3 no-underline">
          <span>Да</span></a><a href="https://docs.github.io/success-test/no.html" target="_blank" class="btn btn-outline mt-3 mr-3 no-underline"><span>нет</span></a>

Пользуемые инструкции

Инструкции в файлах доступны для использования Copilot сразу после сохранения файла(ов). Инструкции автоматически добавляются к запросам, которые вы отправляете в Copilot.

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