Перейти к содержимому

Генератор конфигурации

Copilot Instructions

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

Генератор

Заполните поля и проверьте файл

Предпросмотр обновляется локально после каждого изменения.

1. Основа проекта

Пресет предлагает начальные настройки. Перед использованием сверьте команды и пути с вашим проектом.

Начните с готового пресета — он заполнит основу проекта. Для точной настройки переключитесь на «Ручную настройку».

Уровень детализации

2. Проект

Имя и описание остаются пользовательским текстом и не переводятся автоматически.

3. Stack и tooling

Доступные инструменты зависят от языка и типа проекта.

Технологии и tooling
Дополнительные технологии

Выберите готовые варианты или перечислите свои через запятую.

4. Команды

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

  • Команды scripts требуют настройки package.json и установки выбранных devDependencies; имена scripts сверяйте с проектом.
  • Сверьте dev/build scripts с используемым сборщиком.
  • Тестовый script: test: vitest run.
  • Настройте typecheck: tsc --noEmit. В verify объедините выбранные проверки.
Установка
Разработка
Сборка
Форматирование
Линтинг
Проверка типов
Тесты
E2E-тесты
Проверка
Custom commands

5. Project structure

Предложенные пути можно изменить или удалить. Готовые пути имеют краткое назначение; добавляйте только полезные ориентиры.

6. Rule packs

По умолчанию включены только правила, применимые к выбранному профилю. Выключенные packs не попадут в результат.

Наборы правил для copilot-instructions.md

7. Environment и документы

Указывайте только имена environment variables, без секретных значений. Для каждого документа добавьте относительный путь и краткое назначение.

Имена переменных окружения
Документы проекта

8. Размещение и язык

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

Путь размещения: .github/copilot-instructions.md

9. Additional instructions

Свободный escape hatch для правил, которые не покрыты preset-полями.

О формате и использовании

Copilot Instructions — обычный Markdown с общим контекстом, командами и правилами репозитория для GitHub Copilot. Обязательный YAML frontmatter не нужен. Поддержка инструкций зависит от клиента и функции Copilot; сверяйтесь с официальной документацией.

Официальная документация

Куда сохранить файл

Браузер скачивает copilot-instructions.md. Создайте каталог .github в корне репозитория и переместите файл в .github/copilot-instructions.md.

Как использовать

  1. Выберите готовую основу или настройте проект вручную. Для frontend + backend проверьте оба рабочих каталога и независимые инструменты.
  2. Сверьте предложенные команды и пути с реальной конфигурацией проекта. Добавьте правила, справочные документы с назначением и только имена переменных окружения.
  3. Скачайте copilot-instructions.md и разместите в .github/copilot-instructions.md. Проверьте поддержку repository instructions в используемом клиенте Copilot.

Частые вопросы

Куда положить Copilot Instructions?

Скачанный copilot-instructions.md переместите в .github/copilot-instructions.md. Браузер не создаёт каталог .github.

Это prompt для одной задачи?

Файл содержит общие инструкции репозитория. Task prompts описывают отдельную задачу; этот генератор их не создаёт.

Чем отличаются path-specific instructions?

Path-specific instructions в файлах .instructions.md относятся к выбранным путям. Здесь создаётся один общий Markdown-файл без applyTo и excludeAgent.

Нужно ли проверять команды и документы?

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

Все клиенты Copilot поддерживают файл одинаково?

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

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