Гайд · TNWS AI

Как задать path-specific инструкции для Copilot Code Review

Copilot
6 мин

Настройка .github/instructions/NAME.instructions.md с frontmatter applyTo: glob для точечного Copilot review TypeScript, миграций и других подсистем.

Задача и применимость

Цель — применять специальные критерии review только к файлам определённого языка, каталога или подсистемы. Руководство рассчитано на монорепозиториев, где backend, frontend, migrations и infrastructure требуют разных проверок. Успех здесь означает наблюдаемое состояние: сработавший ruleset, корректный scope веток, прочитанная инструкция, использованное окружение или comments в ожидаемой группе изменений. Текст модели без внешней проверки успехом не считается.

Интерфейс, команды, названия файлов и доступность сверены 13 сентября 2026 года по официальной документации GitHub. Цены и универсальные лимиты не приводятся. Любая доступность зависит от плана, policy и прав пользователя; если пункт отсутствует, не имитируйте его альтернативным write-действием.

Подтверждённая механика

GitHub требует файл NAME.instructions.md внутри .github/instructions и frontmatter с applyTo. Для TypeScript официальный пример использует applyTo: "**/*.ts,**/*.tsx". На GitHub.com path-specific instructions поддерживаются для Copilot cloud agent и Copilot code review.

Точные имена важны: Review new pushes отвечает за повторные циклы, Review draft pull requests — за статус PR, а Review effort level — за глубину. Аналогично, .github/copilot-instructions.md, path-specific instructions и AGENTS.md имеют разные scopes.

Что подготовить до настройки

Запишите OWNER/REPO, target branch, текущий status настройки и критерий отката. Создайте test branch, где нет секретов и production-изменений. Для инструкции подготовьте одно безопасное нарушение правила, которое потом удалите; для окружения — workflow, проверяемый вручную через Actions.

До любого сохранения сделайте screenshot или текстовую запись исходного значения. Это особенно важно для ruleset: ошибка target может распространить review на большее число PR, а дублирующее правило создаст шум. Проверяйте не только включённый checkbox, но и scope.

Готовый шаблон

---
applyTo: "db/migrations/**/*.sql"
---

При review миграции проверяй обратимость, блокировки таблиц, порядок deploy и совместимость старого приложения с новой схемой.

Шаблон — стартовая точка. Замените repository, ветки и инварианты на реальные. Не вставляйте tokens, private URLs и персональные данные. Конфигурационные Markdown/YAML-файлы являются управляющим кодом: их нужно читать в diff и проводить через review.

Пошаговые действия

  1. Создайте .github/instructions, при необходимости добавьте подкаталоги для порядка.

  2. Создайте файл, например .github/instructions/migrations.instructions.md. Суффикс .instructions.md обязателен.

  3. В начале добавьте YAML frontmatter с applyTo. Для рекурсивного SQL в migrations используйте db/migrations/**/*.sql.

  4. Ниже напишите критерии только этой подсистемы: rollback, lock, порядок deploy, совместимость.

  5. Проверьте glob локально по реальным путям. Ошибка src/*.py не охватит вложенные каталоги, тогда как src/**/*.py охватит.

  6. Создайте test PR с одним совпадающим и одним несовпадающим файлом.

  7. Запросите Copilot review и проверьте, что специальные правила применены только к совпадающему path.

  8. Исправьте glob или текст через обычный PR review, если scope оказался шире ожидаемого.

После каждого шага фиксируйте независимый признак: ruleset Active, target branch совпадает, workflow зелёный, comment привязан к ожидаемому файлу. Если признак отсутствует, остановитесь до следующего write-действия.

Готовый промпт

Проверь миграцию по path-specific instructions. Покажи, какой applyTo совпал, затем оцени rollback, locks и совместимость со старой версией приложения.

Промпт должен усиливать конфигурацию, а не заменять её. Укажите scope, инварианты и формат доказательства. Просите сценарий отказа и тест, а не абстрактное «улучшить качество». Для draft или частичного diff явно перечисляйте незавершённые части.

Реалистичный пример входа и результата

Вход: PR меняет db/migrations/20260913_add_index.sql и docs/schema.md.

Ожидаемый результат: Миграционные правила применяются к SQL, но не навязываются документации; замечания содержат сценарий блокировки или отката.

Проверяйте результат по GitHub UI, timeline, Actions log, session attribution, Reviewed Changes или локальному diff. Количество комментариев не является метрикой качества. Полезное замечание указывает конкретный код, воспроизводимый риск и проверку.

Контрольный эксперимент

Хорошая настройка проверяется двумя примерами. Положительный должен попасть в scope и запустить нужное поведение. Отрицательный — не должен: другая branch, несовпадающий path, unstaged файл или PR без нового push. Такая пара обнаруживает слишком широкий glob и неверный target.

Не создавайте искусственную уязвимость в production-коде. Используйте изолированный test fixture или безопасный логический дефект, который сразу удаляется. Результат эксперимента зафиксируйте в PR description, затем очистите временный код до merge.

Сохраните короткий протокол эксперимента: дата, commit SHA, выбранный scope, ожидаемое и фактическое поведение. Он помогает отличить случайный успешный запуск от воспроизводимой настройки и упрощает повторную проверку после обновления GitHub. Не включайте в протокол содержимое закрытых комментариев, секреты или данные пользователей.

Как оценить качество review

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

После принятой suggestion перечитайте полный diff: локальная кнопка или web suggestion может внести корректный фрагмент, но не проверить соседний код. Запустите обязательные tests, lint и build из репозитория. Copilot review — дополнительный слой, не замена CI и человеческому approval.

Типовые ошибки

  • src/*.py не совпадает с глубоко вложенными Python-файлами.
  • Слишком широкий **/* превращает path-specific файл в глобальный.
  • Несовпадающее имя без .instructions.md не соответствует документированному формату.

Если настройка не сработала, сначала проверяйте scope, branch, head/base, enforcement status и права. Не переключайте сразу несколько флагов: иначе невозможно понять причину. Меняйте одну переменную и повторяйте контрольный experiment.

Безопасность и поддержка

Rulesets и instructions могут влиять на всю команду, поэтому используйте принцип минимального scope. Workflow получает только нужные permissions. В инструкции нельзя включать секреты или предлагать чтение приватных данных. MCP context и внешние tools требуют отдельной оценки доверия.

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

Чек-лист финальной проверки

  • Названия меню, файлов и опций сверены 13 сентября 2026 года.
  • OWNER/REPO, target branch и scope указаны явно.
  • Ruleset имеет ожидаемый Enforcement Status.
  • Положительный test case запустил нужный review.
  • Отрицательный test case не попал в scope.
  • В YAML/Markdown нет секретов и внутренних credentials.
  • Suggestions проверены полным diff и тестами.
  • Human approvals и branch protection не ослаблены случайно.
  • Есть понятный способ отката настройки.

FAQ

Какое поле задаёт scope?

applyTo в YAML frontmatter.

Где лежат файлы?

В .github/instructions или её подкаталогах.

Как указать TS и TSX?

Официальный пример: **/*.ts,**/*.tsx.

Суммируются ли глобальные инструкции?

Да, при совпадении path используются path-specific и repository-wide инструкции.

Официальный первоисточник

Источник и изменяемые детали проверены 13 сентября 2026 года. Перед повторением после обновления GitHub или IDE снова откройте ссылку и сравните точные имена пунктов.

Читайте также

Комментарии

Пока тихо. Скажите первое слово