docs: Update AGENTS.md #32
Conversation
- add comprehensive agent guide covering project overview and structure\n- document workflows, quality checks, and references for future agents
Completed Working on "Auto PR Description"✅ Workflow completed successfully. |
Completed Working on "Code Review"✅ Workflow completed successfully. |
![overcut-ai[bot]](https://avatars.githubusercontent.com/in/1367736?s=60&v=4){kind=small}
There was a problem hiding this comment.
Findings: 0 BLOCKER, 0 CRITICAL, 0 MAJOR, 1 MINOR, 0 SUGGESTION, 0 PRAISE.
Key theme: Documentation currently overstates MongoDB-specific test coverage in AGENTS.md, which could mislead future contributors about actual safeguards in src/print.spec.ts.
Next steps: Align AGENTS.md with the current tests or add the MongoDB-focused tests (@map("_id"), @db.ObjectId, @default(auto())) so that the guide accurately reflects available coverage.
| - `src/index.ts` – Public entry point exporting builder helpers and the `print` API. | ||
| - `src/builders.ts` – Core factory/validation logic for schemas, models, enums, scalar/object fields, data sources, and generators. | ||
| - `src/print.ts` – Converts AST nodes to Prisma SDL strings, adds documentation blocks, relation attributes, MongoDB overrides, and calls `formatSchema`. | ||
| - `src/print.spec.ts` – Jest coverage for `print*` helpers, including relation formatting, documentation insertion, MongoDB defaults, and modifier ordering. |
There was a problem hiding this comment.
[MINOR]: Lines 8-13 and 31-41 describe src/print.spec.ts as covering MongoDB defaults, yet the spec never references MongoDB, _id, or ObjectId (searching the file returns no matches). This misleads contributors into assuming that Mongo-only branches are guarded by tests when they are not. Please update AGENTS.md to reflect the actual coverage or add the missing MongoDB tests to src/print.spec.ts.
Suggested fix: Either remove the MongoDB-testing claims from the documentation or add tests in src/print.spec.ts that exercise the Mongo-specific code paths (@map("_id"), @db.ObjectId, @default(auto())).
Summary
Introduce a comprehensive AGENTS.md guide to help future agents understand the project quickly.
Changes
Why
Keeping AGENTS.md up to date ensures automation agents operate with accurate knowledge of the repository layout, workflows, and expectations, reducing onboarding time and mistakes.
Summary
Adds a comprehensive
AGENTS.mdguide that orients future automation agents by outlining the project’s purpose, structure, workflows, and quality standards. The document consolidates tooling expectations, validation rules, and practical commands pulled from the current repository to speed up onboarding and reduce mistakes.Changes
AGENTS.mdcovering project overview, entry points, builders/printing responsibilities, and CI alignment.src/builders.ts,src/print.ts, and associated specs.Commits
Testing
AGENTS.mdto ensure the documented structure, commands, and quality gates match the current repository state.npm run check-format,npm test,npm run build) locally to confirm the guidance remains accurate.