Onboard

AGENTS.md

Add AGENTS.md files to provide context and instructions for Opulent

Opulent supports AGENTS.md, a simple, open standard for providing context and instructions to AI agents. Think of AGENTS.md as a README for agents.

Creating an AGENTS.md File

Just put an AGENTS.md file in your project root (or anywhere else). Opulent will look for the file before it starts working. Here's an example:

# AGENTS.md

## Setup Commands
- Install dependencies: `npm install`
- Start development server: `npm run dev`
- Run tests: `npm test`
- Build for production: `npm run build`

## Code Style
- Use TypeScript strict mode
- Prefer functional components in React
- Use ESLint and Prettier configurations
- Follow conventional commit format

## Testing Guidelines
- Write unit tests for all new functions
- Use Jest for testing framework
- Aim for >80% code coverage
- Run tests before committing

## Project Structure
- `/src` - Main application code
- `/tests` - Test files
- `/docs` - Documentation
- `/public` - Static assets

## Development Workflow
- Create feature branches from `main`
- Use pull requests for code review
- Squash commits before merging
- Update documentation for new features

We also highly recommend doing repo setup to give Opulent context on how to work with your Workspace.