-
Notifications
You must be signed in to change notification settings - Fork 19
docs: Update AGENTS.md #17
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
- add comprehensive agent guide covering services, tooling, and workflows
Completed Working on "Auto PR Description"✅ Workflow completed successfully. |
Completed Working on "Code Review"✅ Workflow completed successfully. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary:
- Findings: 0 BLOCKER / 0 CRITICAL / 2 MAJOR / 0 MINOR / 0 SUGGESTION / 0 PRAISE across 1 file.
- Themes: documentation currently overstates the logistics service’s GraphQL capabilities and claims every service ships a docker-compose manifest even though ecommerce-admin does not.
- Next steps: Update AGENTS.md to accurately describe which services expose GraphQL and which ship docker-compose.dev.yml (or add the missing compose file before restating those guarantees).
| # 🤖 AGENTS GUIDE FOR `amplication/sample-app` | ||
|
|
||
| ## 1. Project Overview | ||
| - **Monorepo scope:** Houses three independently runnable services under `apps/`: a React Admin client (`ecommerce-admin`) plus two NestJS GraphQL backends (`ecommerce-server` for ecommerce workflows and `logistic-server` for logistics and fulfillment). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[MAJOR]: The project overview says both NestJS services expose GraphQL, but apps/logistic-server/src/app.module.ts never registers GraphQLModule and its domain modules only declare REST controllers—only the ecommerce server wires GraphQL. Automation that expects a GraphQL API for logistics will fail against the current code. Please clarify that only apps/ecommerce-server exposes GraphQL today (logistic-server is REST + Swagger) or document the actual steps required to enable GraphQL on the logistics service before reasserting it here.
| ## 1. Project Overview | ||
| - **Monorepo scope:** Houses three independently runnable services under `apps/`: a React Admin client (`ecommerce-admin`) plus two NestJS GraphQL backends (`ecommerce-server` for ecommerce workflows and `logistic-server` for logistics and fulfillment). | ||
| - **Tech highlights:** Node.js + npm, TypeScript everywhere, React 18 with React Admin 5 on the frontend, NestJS 10 with Apollo GraphQL, Prisma 5 for database access, KafkaJS and NATS for messaging, Jest/ts-jest for automated tests, ESLint + Prettier for linting/formatting, and Docker/Docker Compose for container workflows. | ||
| - **Infrastructure baseline:** Each service ships its own `.env`, `Dockerfile`, and `docker-compose.dev.yml`, enabling per-service local development or container packaging. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[MAJOR]: Line 6 claims every service ships .env, Dockerfile, and docker-compose.dev.yml, but apps/ecommerce-admin/ only contains .env and Dockerfile—there is no docker-compose*.yml in that directory. Following these instructions will send agents looking for a non-existent file. Either add the missing compose file for apps/ecommerce-admin or narrow the statement to the backend services that actually provide docker-compose.dev.yml.
Summary
Refreshes
AGENTS.mdwith the latest repository overview so automated agents have accurate guidance.Changes
Why
Keeping
AGENTS.mdaligned with the current repo structure ensures automation agents operate with up-to-date context and best practices.Summary
Refreshes
AGENTS.mdto provide an up-to-date guide for the monorepo’s three services so automation agents have accurate structure and workflow context. Captures development scripts, architecture patterns, and operational rules to keep future changes aligned with current standards.Changes
Commits
Testing