Skip to content

Commit a8a1551

Browse files
docs: Add check_test_parity.sh usage across documentation
- Updated `AGENTS.md`, `README.md`, and `TESTING_GUIDELINES.md` with references and instructions for using the `scripts/check_test_parity.sh` script. - Emphasized the importance of maintaining sync/async parity in tests. - Included examples of the script's usage and default behavior for clarity. Assisted-by: Codex
1 parent 4ba0344 commit a8a1551

3 files changed

Lines changed: 12 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@
1919
- `uv run pre-commit run --all-files` — enforce formatting and lint rules before
2020
pushing.
2121
- `uv run pytest` — execute the suite with the active interpreter.
22+
- `scripts/check_test_parity.sh` — run changed tests and report sync/async
23+
parity gaps (accepts optional base/head refs, defaults to
24+
`upstream/main..HEAD`).
2225
- `uv build` — produce wheels and sdists identical to the release workflow.
2326
- `uvx nox -s tests` — create matrix virtualenvs via nox and execute the pytest
2427
session.

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,3 +36,9 @@ Run the test suite with:
3636
```bash
3737
uv run pytest
3838
```
39+
40+
Check sync/async parity for changed tests (defaults to `upstream/main..HEAD`):
41+
42+
```bash
43+
scripts/check_test_parity.sh
44+
```

TESTING_GUIDELINES.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ iteration required.
1313
request customization, validation failures, file helpers, and live calls. Do
1414
not hide the transport behind a parameter; the test name itself should reveal
1515
which client is under test.
16+
- **Check parity regularly.** Run `scripts/check_test_parity.sh` (defaults to
17+
`upstream/main..HEAD`) to spot missing sync/async counterparts, keeping
18+
parameterized test IDs aligned between transports.
1619
- **Exercise both sides of the contract.** Hermetic tests (via
1720
`httpx.MockTransport`) validate serialization and local validation. Live
1821
suites prove the server behaves the same way, including invalid literal

0 commit comments

Comments
 (0)