Skip to content

Commit 8c943e3

Browse files
committed
Update CONTRIBUTING.md
1 parent 579c194 commit 8c943e3

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -440,14 +440,19 @@ If there are changes, a PR will be generated by mongodb-drivers-pr-bot.
440440
If any errors occurred, the PR description will display the name of the spec along
441441
with stderr from the `bash resync-spec.sh <spec>` command.
442442

443-
There are three patch files that contain known test differences between
444-
PyMongo's tests and the specification:
445-
`.evergreen/patch/diff.patch`: tests where PyMongo intentionally behaves differently than the specification.
446-
This file should rarely be modified, as most of these represent fundamental differences in design or behavior.
447-
`.evergreen/patch/new.patch`: tests for new features that have not yet been implemented in PyMongo.
448-
Tests must be removed from this file as part of the PR that implements their feature.
449-
`.evergreen/patch/update.patch`: tests that have been updated in a way that causes them to fail until their
450-
associated driver change is implemented. Tests must be removed from this file as part of the PR that implements
443+
Naturally, there will be spec tests that will fail if merged since the associated fix
444+
or behavioral change has not been implemented yet. For existing tests that have been
445+
modified, we will add these changes to a patch file (in `/.evergreen/patch`). Each patch
446+
file will be named after a PYTHON ticket and the contents of the file will be the associated
447+
test differences between PyMongo's tests and the specification.
448+
To be clear, changes listed in these patch files will be *undone* by the script, and thus won't
449+
be added to pymongo.
450+
451+
In the case that a new test is added to the spec repo (i.e., a whole new file or folder in the spec repo),
452+
and the associated work isn't implemented yet, we will add the test's path to
453+
`.evergreen/remove-unimplemented-tests.sh` along with a comment indicating the associated PYTHON ticket.
454+
455+
These patch files and/or unimplemented paths must be removed as part of the PR that implements
451456
the fix or behavioral change.
452457

453458
#### Adding to a patch file

0 commit comments

Comments
 (0)