Skip to content

Commit ec50aff

Browse files
Update CONTRIBUTING.md
Co-authored-by: Noah Stapp <[email protected]>
1 parent 4f3cb61 commit ec50aff

File tree

1 file changed

+6
-11
lines changed

1 file changed

+6
-11
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -441,17 +441,12 @@ with the help of patch files through a `git apply -R`. If
441441
appropriate, the bash script then calls
442442
`.evergreen/scripts/create-pr.sh` that actually publishes a PR.
443443

444-
There are three patch files that contain test differences between
445-
pymongo tests and the specs
446-
`.evergreen/patch/diff.patch`: These contain tests that we know we
447-
differ in and do not plan to fix. (This is likely an instance of the
448-
Python driver having a different behaviour.)
449-
`.evergreen/patch/new.patch`: This is for newly added test files that
450-
we fail.
451-
`.evergreen/patch/update.patch`: This is for test changes that were
452-
updated and now fail. In this case, we want to keep the old passing
453-
version, add the diff to this patch file, and open
454-
a new ticket to unskip these.
444+
There are three patch files that contain known test differences between
445+
PyMongo's tests and the specification:
446+
`.evergreen/patch/diff.patch`: tests where
447+
PyMongo intentionally behaves differently than the specification. This file should rarely be modified, as most of these represent fundamental differences in design or behavior.
448+
`.evergreen/patch/new.patch`: tests for new features that have not yet been implemented in PyMongo. 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 associated driver change is implemented. Tests must be removed from this file as part of the PR that implements the fix or behavioral change.
455450

456451
#### Adding to a patch file
457452
Assuming the changes are committed somewhere, to add to any of the

0 commit comments

Comments
 (0)