Contributing

Назначение

Этот раздел объясняет, как вносить изменения в репозиторий Nrgy.js. Здесь собраны правила репозитория по документации, кодстайлу, рабочему процессу и автоматизированным участникам.

Кому это читать

• контрибьюторам, меняющим исходный код, тесты или документацию;
• авторам пакетов внутри монорепозитория;
• автоматизациям и AI-агентам, генерирующим документацию или кодовые правки.

Состав раздела

• Требования к документации: обязательные правила структуры и размещения документации модулей и пакетов.
• Prompt для документации: шаблон prompt'а для агентов, генерирующих документацию модулей.
• Стиль кодирования: практические соглашения, выведенные из текущего кодстайла проекта.
• Процесс разработки: команды, проверки и рабочий процесс по репозиторию.
• Гайд для агентов: ожидания от автоматизированных участников и documentation-агентов.

Примечания

• При добавлении или изменении исходных файлов обновляйте colocated документацию в той же директории.
• Не создавайте отдельную документацию для index.ts; публичные точки входа описывайте в пакетных README.md.
• Держите английскую и русскую документацию синхронизированной.