Что такое AGENTS.md?
Платформа GitHub популяризировала новый открытый формат под названием AGENTS.md. Инициатива позиционирует себя как специализированный, предсказуемый файл для предоставления контекста и инструкций AI-агентам, работающим с кодом. По аналогии с классическим README.md, этот файл служит точкой входа для ИИ, объясняя ему, как взаимодействовать с проектом, чтобы минимизировать ошибки и повысить эффективность.
Структура и ключевые разделы
Формат предполагает четкую организацию информации. В примере реализации выделяются три критически важных блока: настройки среды разработки (Dev environment tips), инструкции по тестированию (Testing instructions) и правила оформления Pull Request (PR instructions). Это позволяет агентам автоматически подтягивать нужные команды без необходимости сканировать весь репозиторий.
| Раздел AGENTS.md | Назначение для AI-агента | Примеры команд/действий |
|---|---|---|
| Dev environment tips | Настройка окружения и навигация по монорепозиторию | pnpm dlx turbo run, pnpm install --filter, создание пакетов через Vite |
| Testing instructions | Запуск CI/CD и валидация изменений | pnpm turbo run test, pnpm vitest run -t, проверка линтеров |
| PR instructions | Стандартизация коммитов и слияния кода | Формат заголовка: <project_name> Title, обязательный запуск pnpm lint |
Техническая реализация и стек
Проект демонстрирует свою работу на базе современного стека JavaScript/TypeScript. Официальный сайт проекта, развернутый на Next.js, доступен по адресу agents.md. Для локальной разработки и тестирования формата используется менеджер пакетов pnpm и сборщик Turborepo, что подчеркивает ориентацию формата на сложные монорепозитории и корпоративные проекты.
- Стек фронтенда: Next.js, React, TypeScript.
- Управление зависимостями: pnpm (с поддержкой фильтров и workspace).
- Инструменты проверки: ESLint, Vitest, TypeScript.
Почему это важно?
С ростом числа AI-ассистентов в IDE (таких как GitHub Copilot, Cursor, Codeium) возникает проблема «галлюцинаций» и непонимания контекста. AGENTS.md предлагает решение: вместо того чтобы ИИ пытался угадать структуру проекта, разработчик явно задает правила игры. Это снижает количество багов, вызванных неправильным использованием внутренних библиотек или нарушением стандартов кодирования, и ускоряет onboarding новых разработчиков (как человеческих, так и искусственных).
Источник: Github ↗