Contributing
Назначение
Этот раздел объясняет, как вносить изменения в репозиторий Nrgy.js. Здесь собраны правила репозитория по документации, кодстайлу, рабочему процессу и автоматизированным участникам.
Кому это читать
- контрибьюторам, меняющим исходный код, тесты или документацию;
- авторам пакетов внутри монорепозитория;
- автоматизациям и AI-агентам, генерирующим документацию или кодовые правки.
Состав раздела
- ../../AGENTS.ru.md: onepager и точка входа для AI-агентов.
- Требования к документации: обязательные правила структуры и размещения документации модулей и пакетов, а также шаблон prompt'а для агентов-генераторов документации.
- Стиль кодирования: паттерны конкретно этого проекта (Atom, Effect, Scope, Controller) с примерами кода.
- Процесс разработки: повседневные команды, структура репозитория и работа с сайтом.
- Релизный процесс: версионирование, публикация и релизные проверки.
Примечания
Полный список правил — в docs_requirements.ru.md. Держите .md и .ru.md документы синхронизированными.