Skip to content

Add AGENT.md with project guidelines for AI agents#5

Open
kingsley-ijomah wants to merge 1 commit intomainfrom
devin/1774448903-add-agent-md
Open

Add AGENT.md with project guidelines for AI agents#5
kingsley-ijomah wants to merge 1 commit intomainfrom
devin/1774448903-add-agent-md

Conversation

@kingsley-ijomah
Copy link
Collaborator

@kingsley-ijomah kingsley-ijomah commented Mar 25, 2026

Summary

Adds a new AGENT.md file to the repository root. This file provides structured instructions and context for AI coding agents working in this codebase, covering:

  • Project overview and tech stack
  • Directory structure
  • How to run, lint, and test the application
  • API endpoints reference
  • Code conventions for both backend (Python) and frontend (TypeScript/React)
  • Key domain terms (e.g., Customization Wizard, Tea Category, Price Modifier)

No code changes — documentation only.

Review & Testing Checklist for Human

  • Verify the content matches your intent — the user request was simply "create a new file in root called AGENT.md" with no content specification. I inferred agent-facing project guidelines; confirm this is what you wanted or adjust as needed.
  • Spot-check directory paths — the project structure tree references paths like frontend/src/app/features/, frontend/src/app/shared/, frontend/src/app/context/. Verify these match the actual repo layout.
  • Check for any missing conventions or instructions you'd want agents to follow (e.g., commit message format, branch naming, PR workflow, or repo-specific rules not captured here).

Notes

  • Content was derived from the existing README.md, WORKSHOP_REQUIREMENTS.md, and actual repo structure inspection.
  • There is intentional overlap with the README; the AGENT.md is tailored for AI agent consumption (more structured, includes linting/testing commands upfront, domain glossary).

Link to Devin session: https://app.devin.ai/sessions/e46772a2bd2d4bc59f261ab995d4011b
Requested by: @kingsley-ijomah


Open with Devin

Co-Authored-By: Kingsley Ijomah <kingsley.ijomah@gravity9.com>
@devin-ai-integration
Copy link

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

Copy link

@amazon-q-developer amazon-q-developer bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛑 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.

Suggested change
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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛑 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.

Suggested change
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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛑 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.

Suggested change
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

Copy link

@devin-ai-integration devin-ai-integration bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 1 additional finding.

Open in Devin Review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant