Contributing

Purpose

This section explains how to contribute changes to the Nrgy.js repository. It collects the repository rules for documentation, coding style, workflow, and automated contributors.

Who Should Read This

• contributors updating source code, tests, or docs;
• package authors working inside the monorepo;
• automation and AI agents generating documentation or code changes.

Contents

• ../../AGENTS.md: onepager and entry point for AI agents.
• Documentation Requirements: mandatory structure and placement rules for source and package documentation, plus the prompt template for documentation-generation agents.
• Coding Style: project-specific patterns (Atom, Effect, Scope, Controller) with code examples.
• Development Workflow: daily commands, repository layout, and website workflow.
• Release Workflow: versioning, publishing, and release-time validation.

Notes

See docs_requirements.md for the full rules. Keep .md and .ru.md documents in sync.