Skip to content

Commit 4f3cb61

Browse files
committed
update contributing to explain patch files
1 parent 1a3d87f commit 4f3cb61

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -436,7 +436,9 @@ you are attempting to validate new spec tests in PyMongo.
436436
`/.evergreen/scripts/resync-all-specs.sh` is a script that will
437437
automatically run once a week. This script calls a python script
438438
`.evergreen/scripts/resync-all-specs.py` that actually does all
439-
the resyncing. If appropriate, the bash script then calls
439+
the resyncing. Then, any desired un-syncing will be accomplished
440+
with the help of patch files through a `git apply -R`. If
441+
appropriate, the bash script then calls
440442
`.evergreen/scripts/create-pr.sh` that actually publishes a PR.
441443

442444
There are three patch files that contain test differences between
@@ -448,9 +450,14 @@ Python driver having a different behaviour.)
448450
we fail.
449451
`.evergreen/patch/update.patch`: This is for test changes that were
450452
updated and now fail. In this case, we want to keep the old passing
451-
version, add the appropriate `git diff` to this patch file, and open
453+
version, add the diff to this patch file, and open
452454
a new ticket to unskip these.
453455

456+
#### Adding to a patch file
457+
Assuming the changes are committed somewhere, to add to any of the
458+
patch files, run `git diff` to show the desired changes and paste the
459+
results into the patch file.
460+
454461
## Making a Release
455462

456463
Follow the [Python Driver Release Process Wiki](https://wiki.corp.mongodb.com/display/DRIVERS/Python+Driver+Release+Process).

0 commit comments

Comments
 (0)