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

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

• Параметр "Использовать файлы инструкций" должен быть включен в параметрах. Эта функция включена по умолчанию. См. инструкции по включению или отключению пользовательских инструкций репозитория далее в этой статье.

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

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

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

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

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

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

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

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

Примеры файлов запроса

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

• react-form.prompt.md — документирует повторно использованную задачу для создания формы.

  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
  

• security-api.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
  …
  

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

Чтобы включить файлы запроса, настройте chat.promptFiles параметр VS Code . Задайте для него true значение или используйте { "/path/to/folder": boolean } нотацию, чтобы указать другой путь. Относительные пути разрешаются из корневых папок рабочей области, а значение .github/prompts по умолчанию используется, если другой путь не указан. Дополнительные инструкции см. в разделе GitHub Copilot в справочнике по параметрам VS Code в документации по Visual Studio Code.

1. .prompt.md Создайте файл в каталоге .github/prompts рабочей области.

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

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

3. Щелкните значок подключения, а затем нажмите кнопку "Запрос" и выберите файл запроса для присоединения в Copilot Chat или Copilot Edits.

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

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

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