Conversation
There was a problem hiding this comment.
Pull request overview
Adds an AGENTS.md file to provide cross-tool guidance for AI coding agents working in the MongoDB Node.js driver repository.
Changes:
- Introduces a standardized set of build/lint/test commands for agents to use.
- Documents high-level architecture and key source/test directory layout.
- Captures repo-specific code conventions (lint-enforced and team conventions) and commit message format.
| Tests require a running MongoDB instance. To start one locally: | ||
|
|
||
| ```bash | ||
| git submodule update --init | ||
| export DRIVERS_TOOLS=$(pwd)/drivers-evergreen-tools |
There was a problem hiding this comment.
The statement "Tests require a running MongoDB instance" is inaccurate: npm run check:unit runs the unit test suite without needing a database (integration tests do). Consider rewording this section to say that integration tests require a running MongoDB deployment, or qualify which test commands need the orchestration steps below.
| ```bash | ||
| npm run check:unit # Unit tests (no database required) | ||
| npm run check:test # Integration tests (requires database) | ||
| npm test # Lint + unit + integration |
There was a problem hiding this comment.
npm test runs more than just "Lint + unit + integration" in this repo (it also triggers the check:lint chain, which includes d.ts build / API Extractor / tsd checks). Consider updating the comment to reflect what npm test actually covers, or point readers at npm run check:lint + npm run test:all explicitly.
| npm test # Lint + unit + integration | |
| npm test # Full verification suite: check:lint chain + unit + integration | |
| # Equivalent explicit commands: npm run check:lint && npm run test:all |
| - **Formatting** — Prettier with single quotes, 2-space tabs, 100-char width, no trailing commas. | ||
|
|
There was a problem hiding this comment.
The formatting bullet says "2-space tabs"; the repo config is tabWidth: 2, i.e., 2-space indentation. Consider rephrasing to avoid implying literal tab characters are required.
|
@copilot address all your comments |
Description
Summary of Changes
Generic AGENTS.md file for your local agent.
Double check the following
npm run check:lint)type(NODE-xxxx)[!]: descriptionfeat(NODE-1234)!: rewriting everything in coffeescript