Skip to main content

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

Узнайте, как адаптировать поведение GitHub Copilot под ваши предпочтения и требования.

В этой статье

Примечание.

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

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

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

Примечание.

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

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

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

  •         **
            [Личные инструкции](#about-personal-instructions)** применяются ко всем разговорам Копилот Чат на сайте GitHub . Они позволяют указать свои индивидуальные предпочтения, такие как предпочтительный язык или стиль ответа, гарантируя, что ответы адаптированы к вашим личным потребностям.
    
  •         **
            [Пользовательские инструкции репозитория](#about-repository-custom-instructions)** применяются к беседам в контексте определенного репозитория. Они полезны для определения специфических стандартов, фреймворков или инструментов кодирования, специфичных для project. Например, можно указать, что репозиторий использует TypeScript и определенную библиотеку, обеспечивая согласованные ответы для всех участников.
    
  •         **
            [Индивидуальные инструкции по организации](#about-organization-custom-instructions)** применяются к обсуждениям в контексте организации на GitHub сайте. Они идеально подходят для применения предпочтений всей организации, таких как общий язык или рекомендации по безопасности. Пользовательские инструкции организации могут устанавливаться только владельцами организаций для организаций с подпиской OR Copilot BusinessКопилот Энтерпрайз .
    

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

Примечание.

Персональные пользовательские инструкции поддерживаются только для GitHub Copilot Чат в GitHub.

Вы можете настроить ответы Копилот ЧатGitHub.com , добавив личные инструкции, которые Copilot будут касаться только вас. Вы делаете это в всплывающем окне на Копилот Чат странице на GitHub.com. См . раздел AUTOTITLE.

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

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

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

    Они указаны в copilot-instructions.md файле в .github каталоге репозитория.

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

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

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

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

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

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

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

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

Примечание.

          **Поддержка:** В настоящее время пользовательские инструкции организации поддерживаются только для Копилот Чат на GitHub.com, Обзор кода Copilot на GitHub.com и Copilot облачный агент на GitHub.com.

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

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

Ниже приведены некоторые примеры инструкций, которые можно добавить:

  • Always respond in Spanish.
  • Do not generate code blocks in responses.
  • For questions related to security, use the Security Docs Knowledge Base.

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

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

В следующем списке показан полный порядок приоритета, при этом инструкции, расположенные выше в этом списке, имеют приоритет над инструкциями, находящимися ниже в списке:

  •         **Персональные** инструкции
    
  •         **Пользовательские инструкции по работе с репозиторием** :
    
    * Path-специфичные инструкции в любом соответствующем файле .github/instructions/**/*.instructions.md * Repository-wide инструкции в файле .github/copilot-instructions.md * Инструкции агента (например, в файле AGENTS.md )
  •         **Организационные** инструкции
    

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

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

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

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

  • Предпочтительный отдельный язык: 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.

Примечание.

  • Обзор кода Copilot читает только первые 4 000 символов любого пользовательского файла инструкций. Любые инструкции сверх этого лимита не повлияют на отзывы, сгенерированные Обзор кода Copilot. Это ограничение не распространяется на Копилот Чат или Copilot облачный агент.
  • При просмотре pull-запроса Copilot использует пользовательские инструкции в базовой ветви pull request. Например, если ваш pull-запрос стремится объединиться my-feature-branch с main, Copilot будет использовать пользовательские инструкции в main.

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

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

## Folder Structure

- `/src`: Contains the source code for the frontend.
- `/server`: Contains the source code for the Node.js backend.
- `/docs`: Contains documentation for the project, including API specifications and user guides.

## 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.

Следующие шаги

  •         [автозаголовок](/copilot/customizing-copilot/adding-personal-custom-instructions-for-github-copilot)
    
  •         [автозаголовок](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
    
  •         [автозаголовок](/copilot/customizing-copilot/adding-organization-custom-instructions-for-github-copilot)
    

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

  •         [автозаголовок](/copilot/concepts/agents/copilot-memory)
    
  •         [автозаголовок](/copilot/reference/customization-cheat-sheet)
    

Примечание.

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

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

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

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

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

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

Примечание.

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

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

Вы можете использовать три типа пользовательских инструкций репозитория в :VS Code

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

    Они указаны в copilot-instructions.md файле в .github каталоге репозитория.

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

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

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

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

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

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

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

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

Примечание.

Файлы с запросами могут public preview измениться.

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

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

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

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

Примеры

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

  •         `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, которую можно использовать to do проверки безопасности 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.

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

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

## Folder Structure

- `/src`: Contains the source code for the frontend.
- `/server`: Contains the source code for the Node.js backend.
- `/docs`: Contains documentation for the project, including API specifications and user guides.

## 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.

Следующие шаги

  •         [автозаголовок](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
    
  •         [автозаголовок](/copilot/tutorials/use-custom-instructions)
    
  •         [автозаголовок](/copilot/reference/customization-cheat-sheet)
    

Примечание.

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

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

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

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

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

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

Примечание.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Примеры

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

  •         `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, которую можно использовать to do проверки безопасности 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.

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

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

## Folder Structure

- `/src`: Contains the source code for the frontend.
- `/server`: Contains the source code for the Node.js backend.
- `/docs`: Contains documentation for the project, including API specifications and user guides.

## 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.

Следующие шаги

  •         [автозаголовок](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
    
  •         [автозаголовок](/copilot/reference/customization-cheat-sheet)
    

Примечание.

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

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

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

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

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

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

Примечание.

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

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

В IDE JetBrains пользовательские инструкции репозитория состоят из одного файла .github/copilot-instructions.md, который вы создаёте в репозитории. Инструкции, которые вы добавляете в файл, должны быть короткими, самостоятельными заявлениями, которые добавляют контекст или релевантную информацию для дополнения запроса 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.

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

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

Примечание.

Файлы с запросами могут public preview измениться.

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

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

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

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

Примеры

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

  •         `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, которую можно использовать to do проверки безопасности 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
    …
    

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

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

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

## Folder Structure

- `/src`: Contains the source code for the frontend.
- `/server`: Contains the source code for the Node.js backend.
- `/docs`: Contains documentation for the project, including API specifications and user guides.

## 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.

Следующие шаги

  •         [автозаголовок](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
    
  •         [автозаголовок](/copilot/tutorials/use-custom-instructions)
    
  •         [автозаголовок](/copilot/reference/customization-cheat-sheet)
    

Примечание.

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

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

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

Примечание.

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

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

В Xcode пользовательские инструкции репозитория состоят из одного файла .github/copilot-instructions.md, который вы создаёте в репозитории. Инструкции, которые вы добавляете в файл, должны быть короткими, самостоятельными заявлениями, которые добавляют контекст или релевантную информацию для дополнения запроса 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.

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

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

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

## Folder Structure

- `/src`: Contains the source code for the frontend.
- `/server`: Contains the source code for the Node.js backend.
- `/docs`: Contains documentation for the project, including API specifications and user guides.

## 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.

Следующие шаги

  •         [автозаголовок](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
    
  •         [автозаголовок](/copilot/tutorials/use-custom-instructions)
    
  •         [автозаголовок](/copilot/reference/customization-cheat-sheet)
    

Примечание.

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

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

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

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

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

Примечание.

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

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

          **Пользовательские инструкции** рабочей области применяются ко всем проектам в рабочей области и позволяют указать инструкции и настройки на уровне рабочей области. Вы можете использовать пользовательские инструкции workspace для предоставления контекста и инструкций Copilot в Eclipse.

          **Project пользовательские инструкции** состоят из одного файла `.github/copilot-instructions.md`, который вы создаёте в project. Инструкции, которые вы добавляете в файл, должны быть короткими, самостоятельными заявлениями, которые добавляют контекст или релевантную информацию для дополнения запроса Copilot .

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

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

Пример

Этот пример файла содержит три инструкции .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.

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

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

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

## Folder Structure

- `/src`: Contains the source code for the frontend.
- `/server`: Contains the source code for the Node.js backend.
- `/docs`: Contains documentation for the project, including API specifications and user guides.

## 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.

Следующие шаги

  •         [автозаголовок](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot)
    
  •         [автозаголовок](/copilot/tutorials/use-custom-instructions)
    
  •         [автозаголовок](/copilot/reference/customization-cheat-sheet)