28 lines
930 B
Markdown
28 lines
930 B
Markdown
---
|
|
description: Rules and guidelines for the AI agent working on this project
|
|
---
|
|
|
|
# Agent Guidelines
|
|
|
|
## Backend Update Rules
|
|
|
|
> **IMPORTANT**: On every backend update (controllers, models, routes, database changes), you MUST update `README.md` accordingly.
|
|
|
|
### Documentation Updates Required For:
|
|
1. **New API endpoints** - Add to API documentation
|
|
2. **Database schema changes** - Update schema docs
|
|
3. **New features** - Document in appropriate section
|
|
4. **Configuration changes** - Update technical stack or setup instructions
|
|
|
|
### V2 Frontend Updates
|
|
|
|
For any changes to the `/v2` hidden frontend, update the dedicated documentation at:
|
|
- `app/Views/v2/README.md`
|
|
|
|
This keeps V2 changes separate from the main README to avoid exposing the hidden UI to the team.
|
|
|
|
## Workflow Preferences
|
|
- Use 2-space indentation for all code
|
|
- Follow existing code patterns and naming conventions
|
|
- Always test changes before committing
|