Add AGENT.md with project guidelines for AI agents#5
Add AGENT.md with project guidelines for AI agents#5kingsley-ijomah wants to merge 1 commit intomainfrom
Conversation
Co-Authored-By: Kingsley Ijomah <kingsley.ijomah@gravity9.com>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
There was a problem hiding this comment.
Summary
This PR adds documentation for AI agents working in the codebase. The content is comprehensive and well-structured, covering project overview, structure, commands, API endpoints, and conventions.
Critical Issues Found: 3
The documentation contains platform-specific Unix/macOS commands that will fail on Windows systems. Since the document explicitly supports both platforms (referencing start.sh and start.bat), all command examples must provide cross-platform alternatives or Windows will be unsupported.
The issues are in:
- Manual backend start command (line 55)
- Backend linting command (line 69)
- Backend-only test command (line 85)
These must be fixed before merge to ensure the documentation functions correctly for all target platforms.
You can now have the agent implement changes and create commits directly on your pull request's source branch. Simply comment with /q followed by your request in natural language to ask the agent to make changes.
| node test.js --e2e | ||
|
|
||
| # Backend only | ||
| cd backend && source venv/bin/activate && pytest -v |
There was a problem hiding this comment.
🛑 Documentation Error: The backend-only test command uses Unix-specific activation syntax that fails on Windows. Provide platform-specific commands to ensure AI agents can run tests on all platforms.
| cd backend && source venv/bin/activate && pytest -v | |
| # Backend only (Unix/macOS) | |
| cd backend && source venv/bin/activate && pytest -v | |
| # Backend only (Windows) | |
| cd backend && venv\Scripts\activate && pytest -v |
|
|
||
| ```bash | ||
| # Backend | ||
| cd backend && source venv/bin/activate && flake8 app/ --max-line-length=120 |
There was a problem hiding this comment.
🛑 Documentation Error: The backend linting command uses Unix-specific activation syntax that fails on Windows. Provide platform-specific commands to ensure AI agents can successfully lint on all platforms.
| cd backend && source venv/bin/activate && flake8 app/ --max-line-length=120 | |
| # Backend (Unix/macOS) | |
| cd backend && source venv/bin/activate && flake8 app/ --max-line-length=120 | |
| # Backend (Windows) | |
| cd backend && venv\Scripts\activate && flake8 app/ --max-line-length=120 |
|
|
||
| # Manual start | ||
| # Backend | ||
| cd backend && source venv/bin/activate && python main.py |
There was a problem hiding this comment.
🛑 Documentation Error: The backend activation command uses Unix-specific syntax that fails on Windows. Since this document targets both platforms (referencing start.sh and start.bat), provide platform-specific commands or reference the cross-platform start scripts instead.
| cd backend && source venv/bin/activate && python main.py | |
| # Backend (Unix/macOS) | |
| cd backend && source venv/bin/activate && python main.py | |
| # Backend (Windows) | |
| cd backend && venv\Scripts\activate && python main.py |
Summary
Adds a new
AGENT.mdfile to the repository root. This file provides structured instructions and context for AI coding agents working in this codebase, covering:No code changes — documentation only.
Review & Testing Checklist for Human
frontend/src/app/features/,frontend/src/app/shared/,frontend/src/app/context/. Verify these match the actual repo layout.Notes
README.md,WORKSHOP_REQUIREMENTS.md, and actual repo structure inspection.Link to Devin session: https://app.devin.ai/sessions/e46772a2bd2d4bc59f261ab995d4011b
Requested by: @kingsley-ijomah