Skip to content

Commit 1c901c7

Browse files
committed
Update CONTRIBUTING.md
1 parent 87d73cc commit 1c901c7

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -434,15 +434,14 @@ you are attempting to validate new spec tests in PyMongo.
434434

435435
### Automated Specification Test Resyncing
436436
There is a script (`/.evergreen/scripts/resync-all-specs.sh`) that will
437-
automatically run once a week to resync all the specs with the [specifications
438-
repo](https://github.com/mongodb/specifications).
437+
automatically run once a week to resync all the specs with the [specifications repo](https://github.com/mongodb/specifications).
439438
If there are changes, a PR will be generated by mongodb-drivers-pr-bot.
440439
If any errors occurred, the PR description will display the name of the spec along
441440
with stderr from the `bash resync-spec.sh <spec>` command.
442441

443442
Naturally, there will be spec tests that will fail if merged since the associated fix
444443
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
444+
modified, we will add these changes to a patch file (in `/.evergreen/spec-patch`). Each patch
446445
file will be named after a PYTHON ticket and the contents of the file will be the associated
447446
test differences between PyMongo's tests and the specification.
448447
To be clear, changes listed in these patch files will be *undone* by the script, and thus won't
@@ -457,13 +456,21 @@ the fix or behavioral change.
457456

458457
#### Adding to a patch file
459458
Assuming the changes are committed somewhere, to add to any of the
460-
patch files, run `git diff` to show the desired changes and paste the
459+
patch files, run `git diff` to show the desired changes to undo and paste (or add) the
461460
results into the patch file.
462461

463-
For example, there are new test files on the most recent commit of the current branch that are failing.
464-
To add those changes to `new.patch`, I would do the following:
462+
For example, there are modifications to test files on the most recent commit of the current branch that are failing.
463+
To add those changes to `PYTHON-1234.patch` (where PYTHON-1234 is the ticket associated with the changes),
464+
I would do the following:
465465
```bash
466-
git diff HEAD~1 path/to/new/file >> .evergreen/patch/new.patch
466+
git diff HEAD~1 path/to/file >> .evergreen/spec-patch/PYTHON-1234.spec-patch
467+
```
468+
469+
#### Running Locally
470+
Both `resync-all-specs.sh` and `resync-all-specs.py` can be run locally (and won't generate a PR).
471+
```bash
472+
./.evergreen/scripts/resync-all-specs.sh
473+
python3 ./.evergreen/scripts/resync-all-specs.py
467474
```
468475

469476
## Making a Release

0 commit comments

Comments
 (0)