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.
PavelSafronov
left a comment
There was a problem hiding this comment.
Awesome start!
Some things I would love to see addressed in this readme:
- specifications, reference https://github.com/mongodb/specifications somehow, mention that this is the source of truth
- mention other repos that our team owns that are relevant, such as js-bson or kerberos
|
|
||
| This is the official MongoDB Node.js driver (`mongodb` npm package). It provides a TypeScript/JavaScript interface for applications to interact with MongoDB deployments. The driver implements the cross-driver MongoDB specifications. | ||
|
|
||
| ## Related Repositories |
There was a problem hiding this comment.
@PavelSafronov thanks for the suggestion! List of related repositories here.
| @@ -0,0 +1,121 @@ | |||
| # AGENTS.md | |||
There was a problem hiding this comment.
We need to include a claude.md that points to this file, also
|
I tried to run it through claude for best practices, and here's its suggestion for tightening things: Any thoughts from @tadjik1 @PavelSafronov ? |
I replied on the PR. |
|
Thanks! I copied those suggestions (about generated code and public surface of the library) over. Please take a look. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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