-
Notifications
You must be signed in to change notification settings - Fork 11
Description
Component
- formulus (React Native mobile app)
- formulus-formplayer (React web app)
- synkronus (Go backend server)
- synkronus-cli (Command-line utility)
- Documentation
- Other (please specify)
Feature Description
Introduce first-class support for AI coding agents across the monorepo to improve developer productivity and onboarding. This includes standardized AGENTS.md guidance files and optional custom "skills" or task-specific instructions where appropriate for each component.
The goal is to make it easier for AI assistants (e.g., Claude, ChatGPT, Cursor, etc.) to understand project conventions, architecture, workflows, and common development tasks.
Problem Statement
AI-assisted development is becoming a normal part of engineering workflows. However, without structured guidance, agents often lack context about:
- repository structure
- architectural decisions
- development workflows
- build/test commands
- coding conventions
- cross-component interactions
In a multi-component monorepo this leads to inconsistent suggestions, wasted time explaining the same context repeatedly, and occasional incorrect changes.
Proposed Solution
Add standardized AI-agent support across the repository:
-
Repository-level
AGENTS.md- High-level overview of the monorepo
- Architecture description
- How the components interact
- Shared development workflows
-
Component-level
AGENTS.md(where useful)- Local architecture and conventions
- Key directories
- Typical development tasks
- Testing and build commands
-
Custom agent "skills"
Where useful, define reusable instructions for common tasks such as:- generating form definitions
- working with the Synkronus API
- debugging React Native issues
- adding new CLI commands
-
Documentation updates
- Explain how developers can use AI agents effectively in this repository
- Document the purpose and conventions of
AGENTS.md
The implementation should remain lightweight and documentation-focused so it does not introduce maintenance burden.
Alternatives Considered
- Doing nothing and relying on developers to provide context manually
- Adding ad-hoc prompts or instructions in various documentation pages
Both approaches tend to fragment knowledge and make AI-assisted workflows less reliable.
Additional Context
Several tools and editors now support repository-level guidance files for AI agents. Establishing these conventions early should make the codebase more accessible for both human and AI contributors as the project grows.