Гайд · TNWS AI

Как использовать AGENTS.md для контекста Copilot Code Review

Copilot
6 мин

Практический AGENTS.md для Copilot Code Review: архитектурные инварианты, ближайший файл в дереве, шаблон для сервиса и проверка через pull request.

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

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

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

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

GitHub указывает, что AGENTS.md можно хранить в разных местах репозитория; при работе Copilot ближайший файл в directory tree получает приоритет. Code review читает agent instructions из head branch.

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

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

Область: services/billing.
Инварианты:
- деньги хранятся в minor units;
- write-операции требуют idempotency key;
- внешний вызов запрещён внутри DB transaction;
Проверка: unit tests и integration webhook duplicate.

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

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

  1. Определите каталог с самостоятельными архитектурными правилами, например services/billing.

  2. Создайте AGENTS.md в корне репозитория для общих сведений либо ближе к подсистеме для локального приоритета.

  3. Запишите назначение, инварианты, команды проверки и намеренные паттерны. Не вставляйте секреты и временную задачу.

  4. Если есть вложенный AGENTS.md, явно избегайте противоречия с корневым: ближайший файл имеет приоритет.

  5. Добавьте файл в head branch test PR вместе с небольшим изменением подсистемы.

  6. В description PR назовите инвариант, который должен быть проверен.

  7. Запросите Copilot review и убедитесь, что замечание использует нужный ближайший AGENTS.md.

  8. После проверки удалите искусственный дефект и оставьте инструкции только если они подтверждены командой.

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

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

При review используй ближайший AGENTS.md. Для изменённых файлов назови применённый инвариант и проверь idempotency, minor units и границы транзакции.

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

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

Вход: Изменён services/billing/webhook.ts, рядом находится AGENTS.md с тремя инвариантами.

Ожидаемый результат: Review применяет billing-контекст, находит вызов внешнего API внутри transaction и предлагает проверяемое исправление.

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

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

  • Корневой AGENTS.md может быть перекрыт ближайшим вложенным файлом.
  • Противоречивые инструкции делают review непредсказуемым.
  • AGENTS.md из head branch требует такого же внимательного 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

Где можно хранить AGENTS.md?

В разных каталогах репозитория.

Как выбирается файл?

Приоритет получает ближайший AGENTS.md в directory tree.

Подходит ли он для архитектурного контекста?

Да: GitHub рекомендует описывать намеренные patterns, архитектуру, testing и implementation practices.

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

Для PR review — из head branch.

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

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

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

Комментарии

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