-
Notifications
You must be signed in to change notification settings - Fork 19
docs: Update AGENTS.md #16
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 repository-wide guidance for agents\n- document service structure, workflows, and best practices\n- highlight tooling, testing, and PR expectations
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.
Totals: 0 BLOCKER / 0 CRITICAL / 1 MAJOR / 2 MINOR.
Key themes:
- AGENTS.md over-promises available setup artifacts (e.g.,
.env.example, docker-compose files) leading to broken onboarding steps. - Testing guidance references Jest config files that do not exist, so contributors cannot follow the documented workflow.
Next steps:
- Either add the missing
.env.exampletemplates and docker-compose manifests that the guide references, or update AGENTS.md to describe the actual files and workflows that exist today. - Align the testing section with the real Jest configuration locations (currently in each package.json) or add the referenced
jest.config.tsfiles.
| ### Run ecommerce-server locally | ||
| ```bash | ||
| cd apps/ecommerce-server | ||
| cp .env.example .env # customize secrets |
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 "Run ecommerce-server locally" instructions tell agents to copy .env.example to .env, but none of the services actually include .env.example—only committed .env files—so the very first setup command fails. Suggested fix: add .env.example templates for each service or update the guide to direct agents to edit the existing .env files directly.
|
|
||
| ## Development Guidelines & Workflows | ||
| ### Environment & Configuration | ||
| - Each service ships `.env`, `Dockerfile`, `docker-compose.yml`, and `docker-compose.dev.yml` for local infra. |
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.
[minor]: The Environment section claims every service ships .env, Dockerfile, docker-compose.yml, and docker-compose.dev.yml, but the frontend at apps/ecommerce-admin only has .env and a Dockerfile, so contributors are told to rely on compose manifests that do not exist. Suggested fix: scope the statement to the backend services or add the missing compose files for the admin client.
| - **Authentication:** | ||
| - Ecommerce server uses JWT + Passport; update strategies in `src/auth`. | ||
| - Logistic server enforces HTTP Basic; credentials sourced from `.env`. | ||
| - **Testing:** Jest is configured per service (`apps/*/jest.config.ts`). Add specs under `src/tests/` or alongside modules ending with `.spec.ts`. |
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.
[minor]: The Testing section states that Jest is configured per service via apps/*/jest.config.ts, but no such files exist—the Jest configuration lives inside each package.json. This misleads contributors trying to adjust tests. Suggested fix: either add the referenced jest.config.ts files or update the text to explain that Jest is configured via the jest block in each package.json.
Summary
Refreshes
AGENTS.mdwith the latest knowledge an AI contributor needs to work safely within the monorepo.Changes
Why
Keeping
AGENTS.mdsynchronized with the repository structure ensures automation agents have clear guardrails and context before making changes.Summary
This PR refreshes
AGENTS.mdto equip automation contributors with an up-to-date overview of the monorepo’s services, tooling, and development workflows. The guide now captures stack conventions, environment setup expectations, and best practices needed to work safely across ecommerce and logistics applications.Changes
Commits
Testing
AGENTS.mdto ensure described services, scripts, and paths align with the current repository layout.