Настройка ответов чата GitHub Copilot

Примечание.

Эта версия этой статьи содержит пользовательские инструкции на веб-сайте GitHub . Щелкните вкладки выше для других сред.

Примечание.

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

Примечание.

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

Примечание.

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

Примечание.

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

Настройка ответов Чат GitHub Copilot

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

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

Личные пользовательские инструкции применяются ко всем беседам с Copilot Chat на веб-сайте GitHub . Они позволяют указать свои индивидуальные предпочтения, такие как предпочтительный язык или стиль ответа, гарантируя, что ответы адаптированы к вашим личным потребностям.
Пользовательские инструкции репозитория применяются к беседам в контексте определенного репозитория. Они полезны для определения стандартов программирования, платформ или инструментов для конкретных проектов. Например, можно указать, что репозиторий использует TypeScript и определенную библиотеку, обеспечивая согласованные ответы для всех участников.
Пользовательские инструкции организации (общедоступная предварительная версия) применяются к беседам в контексте организации на веб-сайте GitHub . Они идеально подходят для применения предпочтений всей организации, таких как общий язык или рекомендации по безопасности. Пользовательские инструкции организации можно задать только владелец организации для организаций с подпиской Copilot Enterprise.

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

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

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

Этот пример файла содержит три инструкции .github/copilot-instructions.md для Copilot.

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.

Примеры пользовательских инструкций, используемых для настройки Проверка кода Copilot, см. в разделе Использование проверки кода GitHub Copilot.

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

Существует два типа файлов, которые можно использовать для предоставления контекста и инструкций Чат GitHub Copilot в VS Code:

Пользовательские инструкции репозитория позволяют указать инструкции и настройки на уровне репозитория в одном файле, которые применяются к любой беседе, проведенной в контексте репозитория.
Файлы запросов (общедоступная предварительная версия) позволяют сохранять общие инструкции запроса и соответствующий контекст в файлах Markdown (*.prompt.md), которые затем можно повторно использовать в запросах чата. Файлы запроса доступны только в VS Code.

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

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

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

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

Примечание.

It is possible for multiple types of custom instructions to apply to a conversation. Personal instructions take the highest priority, followed by repository instructions, with organization instructions prioritized last. However, all sets of relevant instructions are still combined and provided to Copilot Chat.
Whenever possible, you should avoid providing conflicting sets of instructions. If you are concerned about response quality, you can also choose to temporarily disable repository instructions. See Добавление пользовательских инструкций репозитория для GitHub Copilot.

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

Личные пользовательские инструкции:
- Предпочтительный отдельный язык: Always respond in Portuguese.
- Индивидуальные настройки ответа: Explain a single concept per line. Be clear and concise.
Пользовательские инструкции репозитория:
- Стандарты программирования: Use early returns whenever possible.
- Платформы: Use Vue with the PrimeVue library. или Use Typescript rather than Javascript.
- Параметры стиля кода: Use camel case for variable names.
Пользовательские инструкции организации:
- Описание того, как ответить на определенные вопросы: For questions related to security, use the Security Docs Knowledge Base or advise people to consult with #security on Slack.
- Предпочтительный язык для компании, которая исключительно говорит на одном языке: Always respond in Portuguese.
- Параметры всей организации: Do not generate code blocks in responses.

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

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

Типичные примеры такой ситуации:

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

Пример

Этот пример файла содержит три инструкции .github/copilot-instructions.md для Copilot.

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.

Примеры пользовательских инструкций, используемых для настройки Проверка кода Copilot, см. в разделе Использование проверки кода GitHub Copilot.

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

Примечание.

Файлы запроса : public preview и подлежат изменению.

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

Типичные примеры такой ситуации:

Создание кода. Создание повторно используемых запросов для компонентов, тестов или миграций (например, форм React или макетов API).
Опыт работы с доменом. Совместное использование специализированных знаний с помощью запросов, таких как методы безопасности или проверки соответствия требованиям.
Совместная работа группы. Шаблоны документов и рекомендации со ссылками на спецификации и документацию.
Адаптация. Создайте пошаговые руководства по сложным процессам или шаблонам для конкретных проектов.

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

Примеры

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

New React form.prompt.md — содержит инструкции для повторно используемой задачи для создания формы с помощью React.

Your goal is to generate a new React form component.

Ask for the form name and fields if not provided.

Requirements for the form:
- Use form design system components: [design-system/Form.md](../docs/design-system/Form.md)
- Use `react-hook-form` for form state management:
  - Always define TypeScript types for your form data
  - Prefer *uncontrolled* components using register
  - Use `defaultValues` to prevent unnecessary rerenders
- Use `yup` for validation:
  - Create reusable validation schemas in separate files
  - Use TypeScript types to ensure type safety
  - Customize UX-friendly validation rules

API security review.prompt.md — содержит повторно используемые сведения о методах безопасности для REST API, которые можно использовать для проверки безопасности ИНТЕРФЕЙСов REST API.
```
Secure REST API review:
- Ensure all endpoints are protected by authentication and authorization
- Validate all user inputs and sanitize data
- Implement rate limiting and throttling
- Implement logging and monitoring for security events
…
```

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

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

Типичные примеры такой ситуации:

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

Пример

Этот пример файла содержит три инструкции .github/copilot-instructions.md для Copilot.

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.

Примеры пользовательских инструкций, используемых для настройки Проверка кода Copilot, см. в разделе Использование проверки кода GitHub Copilot.

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

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

Типичные примеры такой ситуации:

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

Пример

Этот пример файла содержит три инструкции .github/copilot-instructions.md для Copilot.

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который создается в репозитории. Инструкции, добавляемые в файл, должны быть короткими, автономными операторами, которые добавляют контекст или соответствующие сведения для дополнения вопросов чата.

Типичные примеры такой ситуации:

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

Пример

Этот пример файла содержит три инструкции .github/copilot-instructions.md для Copilot.

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.

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

Добавляемые инструкции должны в идеале быть короткими, автономные инструкции предоставляют 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.