Skip to content

Conversation

@overcut-ai
Copy link

@overcut-ai overcut-ai bot commented Jan 8, 2026

Summary

Refreshes AGENTS.md with the latest repository overview so automated agents have accurate guidance.

Changes

  • Added a comprehensive project overview covering all three services in the monorepo
  • Documented structure, tooling, quality standards, and common workflows per service
  • Captured critical rules, examples, and references for future agents

Why

Keeping AGENTS.md aligned with the current repo structure ensures automation agents operate with up-to-date context and best practices.

Summary

Refreshes AGENTS.md to 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

  • Documentation: Added a comprehensive AGENTS guide covering project overview, repository structure, development guidelines, and architecture patterns for all services.
  • Documentation: Documented critical rules, common tasks, and reference examples to guide automation agents and contributors.
  • Documentation: Listed tooling standards, quality expectations, and supporting resources to keep documentation and workflows synchronized.

Commits

Testing

  • Review AGENTS.md in a Markdown renderer to ensure formatting and tables display correctly.
  • Verify referenced directories, scripts, and tooling align with the current repository structure.

- add comprehensive agent guide covering services, tooling, and workflows
@overcut-ai
Copy link
Author

overcut-ai bot commented Jan 8, 2026

Completed Working on "Auto PR Description"

✅ Workflow completed successfully.


👉 View complete log

@overcut-ai
Copy link
Author

overcut-ai bot commented Jan 8, 2026

Completed Working on "Code Review"

✅ Workflow completed successfully.


👉 View complete log

Copy link
Author

@overcut-ai overcut-ai 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:

  • 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).
Copy link
Author

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.
Copy link
Author

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.

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.

2 participants