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

О кастомизации Copilot ответов

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

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

Доступные типы пользовательских инструкций и Copilot функции, используемые ими, зависят от клиента и поверхности (GitHub.com, , Visual Studio Code, , Visual StudioJetBrains IDEsXcode и Eclipse). Чтобы проверить, какие типы поддерживают среду, см. раздел Поддержка различных типов пользовательских инструкций. Сведения о поддерживаемых идентификаторах и версиях см. в разделе Матрица функций Copilot.

Примечание.

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

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

Пользовательские инструкции могут применяться на разных уровнях:

Type	Scope	Пример использования
Личные инструкции	Ваши беседы с Copilot	Укажите индивидуальные предпочтения, например предпочитаемый язык или стиль ответа.
Пользовательские инструкции репозитория	Беседы с выполняемыми Copilot в контексте репозитория, проекта, пути или поддерживаемого агента	Описание языков, платформ, инструментов, архитектуры и соглашений по программированию, используемых в проекте.
Пользовательские инструкции организации	Беседы с Copilot при использовании в контексте организации	Предоставьте язык, безопасность, соответствие или рекомендации по ответу на уровне организации.

Некоторые клиенты (JetBrains IDEs и Xcode) предоставляют дополнительные глобальные механизмы инструкций, рабочих областей или проектов. Эти механизмы не всегда сопоставляют напрямую с личными, репозиториями и инструкциями организации.GitHub

О персональных инструкциях

Личные инструкции, настроенные для GitHub.com применения GitHub Copilot Chat in GitHub. Другие клиенты, например Copilot CLI, используют локальные файлы для личных инструкций. См . раздел AUTOTITLE.

Вы можете настроить Copilot Chat способ реагирования на вас GitHub.com , добавив личные инструкции. Эти инструкции применяются только к вам. Например, можно указать предпочитаемый язык, уровень детализации или структурирование ответов. См . раздел AUTOTITLE.

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

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

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

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

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

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

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

Они указываются в файлах с именами AGENTS.md, CLAUDE.mdили GEMINI.md.

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

Для просмотра тщательно подобранной коллекции примеров см. AUTOTITLE.

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

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

Какие типы пользовательских инструкций репозитория можно использовать (инструкции по использованию репозитория, пути или агента) зависят от среды и задачи, например чата, работы в облаке или проверки запроса на вытягивание. Например, среда может поддерживать инструкции по пути для одной задачи, но не другой. Сведения о поддержке настройки см. в разделе Поддержка различных типов пользовательских инструкций. Сведения о поддерживаемых идентификаторах и версиях см. в разделе Матрица функций Copilot.

О специальных инструкциях по организации

Примечание.

Поддержка: Пользовательские инструкции организации в настоящее время поддерживаются для сеансов, выполняемых на GitHub веб-сайте (в облачных песочницах или в GitHub Actions) и для Copilot code review. Они не поддерживаются в локальных клиентских сеансах.

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

Пользовательские инструкции организации можно настроить только для организаций с подпиской или Copilot Enterprise подпискойCopilot Business.

Например, инструкции организации могут:

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

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

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

Приоритет зависит от клиента и функции. Большинство поверхностей и клиентов, в том числе Copilot CLIVisual Studio CodeVisual Studio, объединяют применимые файлы инструкций без определения общего порядка приоритета.

Для Copilot Chat этого GitHub.comпредоставляются Copilotвсе соответствующие инструкции. Порядок приоритета, от самого высокого до наименьшего, составляет:

Личные инструкции
Пользовательские инструкции репозитория:
1. Инструкции для конкретного пути в любом применимом .github/instructions/**/*.instructions.md файле
2. Инструкции по всему репозиторию.github/copilot-instructions.md
3. Инструкции агента, такие как инструкции AGENTS.md в файле
Пользовательские инструкции организации

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

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

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

Распространенные варианты использования:

Параметры ответа. Укажите предпочтительный язык, структуру ответа, тон или уровень объяснения.
контекст Project. Объясните назначение, архитектуру или домен репозитория.
Языки и платформы. Определите языки, библиотеки, платформы и версии, используемые проектом.
Соглашения о кодировании и тестировании. Описание именования, форматирования, тестирования, обработки ошибок или стандартов документации.
Обзор и руководство по безопасности. Определите проблемы, которые должны обратить особое внимание, когда поддерживаемые проверки функций или код изменений.
Требования организации. Предоставьте язык на уровне организации, безопасность, соответствие или руководство по поддержке.

Рассмотрим пример.

Личная инструкция: Always respond in Portuguese.
Личная инструкция: Explain a single concept per line. Be clear and concise.
Инструкция репозитория: Use Vue with the PrimeVue library.
Инструкция репозитория: Use early returns whenever possible.
Инструкция организации: For questions related to security, use the Security Docs Knowledge Base.
Инструкция организации: Do not generate code blocks in responses.

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

Примечание.

При проверке запроса Copilot на вытягивание считывает пользовательские инструкции репозитория, инструкции агента и навыки агента из головной ветви (ветвь с изменениями), а не базовую ветвь. Например, при слиянии my-feature-branch``mainс ними Copilot используются инструкции и навыки my-feature-branch, позволяющие протестировать изменения в одном запросе на вытягивание, не объединяя их в первую очередь.

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

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

Точную структуру, используемую для файлов инструкций, зависит от проекта и необходимости, но следующие рекомендации предоставляют хорошую отправную точку:

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

Следующий файл инструкций является примером этих практик в действии:

# Project Overview

This project is a web application that allows users to manage their tasks and to-do lists. It is built using React and Node.js, and uses MongoDB for data storage.

## Libraries and Frameworks

- React and Tailwind CSS for the frontend.
- Node.js and Express for the backend.
- MongoDB for data storage.

## Coding Standards

- Use semicolons at the end of each statement.
- Use single quotes for strings.
- Use function based components in React.
- Use arrow functions for callbacks.

## UI guidelines

- A toggle is provided to switch between light and dark mode.
- Application should have a modern and clean design.

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

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

Например, следующие инструкции могут не иметь предполагаемых результатов:

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.