PYTHON-5768: AGENTS.md standardization for all DBX Repositories#2819
Open
sophiayangDB wants to merge 4 commits into
Open
PYTHON-5768: AGENTS.md standardization for all DBX Repositories#2819sophiayangDB wants to merge 4 commits into
sophiayangDB wants to merge 4 commits into
Conversation
sophiayangDB
changed the title
Jibola
requested changes
May 27, 2026
|
|
||
| ## Project Structure | ||
| - `pymongo/` — sync driver (MongoClient, Collection, Database, etc.) | ||
| - `pymongo/asynchronous/` — async API, mirrors `pymongo/` |
Contributor
There was a problem hiding this comment.
Suggested change
| - `pymongo/asynchronous/` — async API, mirrors `pymongo/` | |
| - `pymongo/asynchronous/` — async API, mirrors `pymongo/synchronous/` |
| > **Never** run `pip install bson`. PyMongo ships its own `bson`; the PyPI `bson` package silently breaks things. | ||
|
|
||
| ## Project Structure | ||
| - `pymongo/` — sync driver (MongoClient, Collection, Database, etc.) |
Contributor
There was a problem hiding this comment.
Suggested change
| - `pymongo/` — sync driver (MongoClient, Collection, Database, etc.) | |
| - `pymongo/synchronous/` — sync driver (MongoClient, Collection, Database, etc.); generated from `pymongo/asynchronous/` using unasync |
| ## Testing | ||
| Tests require a live MongoDB server (`just run-server` above). | ||
|
|
||
| When modifying sync code, also update the async counterpart: |
Contributor
There was a problem hiding this comment.
Suggested change
| When modifying sync code, also update the async counterpart: | |
| Never modify pymongo/synchronous code first; update the async counterpart and run our `tools/synchro.py` script: |
| Tests require a live MongoDB server (`just run-server` above). | ||
|
|
||
| When modifying sync code, also update the async counterpart: | ||
| 1. Make changes in `pymongo/` and `test/`. |
Contributor
There was a problem hiding this comment.
Suggested change
| 1. Make changes in `pymongo/` and `test/`. | |
| 1. Make changes in `pymongo/asynchronous` or top-level `pymongo/` files and `test/`. |
Contributor
|
We don't want to remove copilot instructions based on feedback from @NoahStapp that Copilot does not read AGENTS. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PYTHON-5768
Changes in this PR
Added an AGENTS.md for PyMongo based on guidelines from DRIVERS-3428. Removed
.github/copilot-instructions.mdin favor of a centralizedAGENTS.md.Test Plan
N/A
Checklist
Checklist for Author
Checklist for Reviewer