Skip to content

Commit 0fe1691

Browse files
authored
PYTHON-5118 - Improve contributing documentation of synchro (mongodb#2139)
1 parent a641337 commit 0fe1691

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

CONTRIBUTING.md

+5
Original file line numberDiff line numberDiff line change
@@ -261,6 +261,11 @@ To prevent the `synchro` hook from accidentally overwriting code, it first check
261261
of a file is changing and not its async counterpart, and will fail.
262262
In the unlikely scenario that you want to override this behavior, first export `OVERRIDE_SYNCHRO_CHECK=1`.
263263

264+
Sometimes, the `synchro` hook will fail and introduce changes many previously unmodified files. This is due to static
265+
Python errors, such as missing imports, incorrect syntax, or other fatal typos. To resolve these issues,
266+
run `pre-commit run --all-files --hook-stage manual ruff` and fix all reported errors before running the `synchro`
267+
hook again.
268+
264269
## Converting a test to async
265270
The `tools/convert_test_to_async.py` script takes in an existing synchronous test file and outputs a
266271
partially-converted asynchronous version of the same name to the `test/asynchronous` directory.

0 commit comments

Comments
 (0)