Гайд для агентов

Назначение

Этот гайд описывает, как автоматизированные участники и AI-агенты должны работать в репозитории Nrgy.js.

Базовые правила

• Перед генерацией или изменением документации прочитайте требования к документации.
• Если задача связана именно с генерацией документации по исходникам, используйте documentation prompt.
• Держите английские .md и русские .ru.md документы синхронизированными.
• Не создавайте отдельную документацию для index.ts.

Ожидания от изменений исходников

• Предпочитайте небольшие точечные правки широким переписываниям.
• Сохраняйте текущую структуру пакетов и публичные имена пакетов.
• Обновляйте тесты и документацию вместе с изменениями публичного API.
• Соблюдайте существующий стиль кода, именования и форматирования.

Ожидания от изменений документации

• Пакетные обзоры должны жить в пакетных README.md.
• Статьи по модулям должны содержать назначение, обзор, концептуальную архитектуру, публичный API и примеры использования.
• Примеры должны отражать текущий код, а не устаревшие API.

Проверки

• Используйте проектные команды вроде npm run check, npm run test и npm run build, если изменение требует валидации.
• Если проверки не запускались, явно указывайте это в итоговом отчете.