Файл AGENTS.md

AGENTS.md — файл с инструкциями и контекстом для агентов на основе искусственного интеллекта. Файл обычно находится в корне репозитория и служит аналогом README.md для агентов. Для монорепозиториев AGENTS.md можно поместить в каждый подпроект. В таком случае агенты будут отдавать приоритет инструкциям, которые находятся ближе всего к редактируемому файлу.

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

  • обзор проекта;
  • команды для сборки и тестирования;
  • рекомендации по стилю кода;
  • инструкции по тестированию и контролю качества;
  • правила оформления предложений изменений;
  • требования безопасности.

AI-функциональность SourceCraft также учитывает контекст из AGENTS.md:

Подробнее об AGENTS.md см. в репозитории проекта на GitHub и на официальном сайте.

Пример

Telegram-бот для личных напоминаний и todo-задач. Бот запоминает сообщения пользователя и присылает уведомления в указанную дату и время.

## Технологический стек

* Python 3.12
* python-dotenv
* Aiogram 3.x (Telegram Bot API)
* SQLite + aiosqlite (хранилище задач и напоминаний)
* AsyncIOScheduler (планировщик задач)

## Стиль кода

* каждый handler — в отдельном файле в папке `bot/handlers/`.
* не пиши длинные функции > 40 строк.
* добавляй тесты для всех новых функций.
* добавляй комментарии для сложной логики.
* нельзя использовать `time.sleep()` — только `await asyncio.sleep()`.

## Запрещено

* предлагать переход на другие базы данных;
* предлагать переход на другие API.

## Команды для PR

* `/build` — сборка проекта;
* `/test` — запуск тестов;
* `/lint` — проверка стиля кода.
Предыдущая
Следующая