Гайд · TNWS AI

Как настроить Copilot Code Review через copilot-instructions.md

Copilot

13 сентября 2026 6 мин—

Репозиторные инструкции для Copilot Code Review в .github/copilot-instructions.md: готовый шаблон, проверка из head branch и тестовый pull request.

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

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

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

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

Для repository-wide guidance GitHub указывает .github/copilot-instructions.md. При review инструкции читаются из head branch PR, а не base branch, поэтому их можно тестировать в том же pull request до merge.

Точные имена важны: 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.

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

При code review:
- проверяй tenant isolation и авторизацию до обращения к данным;
- требуй негативный тест для новых ветвей ошибок;
- не предлагай изменение публичного API без указания migration plan;
- каждое замечание связывай с конкретным сценарием отказа.

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

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

Создайте каталог .github, если его нет, и файл .github/copilot-instructions.md.
Опишите только устойчивые критерии repository-wide review. Не помещайте сюда задачу одного PR.
Для каждого правила добавьте проверяемый признак: тест, path, инвариант или сценарий отказа.
Не копируйте style guide целиком. Сошлитесь на существующий файл и выделите критичные правила.
Создайте branch с инструкциями и test PR. Помните: Copilot прочитает файл именно из head branch.
Добавьте в test PR намеренное безопасное нарушение одного правила и запросите review.
Проверьте, что комментарий относится к правилу и корректному месту diff. Затем устраните тестовое нарушение.
После merge отслеживайте ложные срабатывания и меняйте инструкции обычным code review.

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

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

Проверь этот PR по `.github/copilot-instructions.md`. В итоговом обзоре перечисли применённые правила и для каждого замечания укажи сценарий отказа и тест.

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

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

Вход: Head branch добавляет инструкции про tenant isolation и меняет query без tenant filter.

Ожидаемый результат: Review ссылается на нарушение isolation, предлагает негативный тест и демонстрирует, что новые инструкции сработали до merge.

Проверяйте результат по 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.

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

Инструкции из base branch не используются вместо версии head branch при текущем PR.
Слишком общие фразы дают непроверяемые советы.
Файл является управляющей конфигурацией и должен проходить review.

Если настройка не сработала, сначала проверяйте 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

Где хранить файл?

В .github/copilot-instructions.md.

Из какой ветки он читается?

Из head branch pull request.

Можно ли проверить до merge?

Да, именно благодаря чтению из head branch.

Что писать?

Устойчивые repository-wide критерии, привязанные к тестам и сценариям.

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

GitHub Docs

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