Skip to content

Commit 40c7d88

Browse files
docs: Add code and test validation checklists to AGENTS.md
- Introduced a "Code Quality Checklist" with steps for formatting, linting, and type checking without runtime tests. - Added a "Test Validation Checklist" for running focused and full compatibility tests, including new coverage validation steps. - Clarified the distinction between code quality checks and runtime validations. Assisted-by: Codex
1 parent 08a2f1b commit 40c7d88

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,30 @@
3030
`coverage/py3.12/coverage.xml`, `coverage/py3.12/coverage.md`,
3131
`coverage/py3.12/html/`).
3232

33+
## Code Quality Checklist
34+
35+
- When code changes are complete, or when asked to "check code quality", run
36+
this default sequence:
37+
- `uv run ruff format .`
38+
- `uv run ruff check .`
39+
- `uv run basedpyright`
40+
- Do not include pytest or nox runs in the default "code quality" request; treat
41+
runtime tests as a separate validation step.
42+
43+
## Test Validation Checklist
44+
45+
- Run tests separately from code quality checks:
46+
- `uv run pytest -n 8 --maxschedchunk 2` (or a focused module when iterating)
47+
- For full compatibility before handoff/PR, run:
48+
- `uvx nox -s tests` (Python 3.10-3.14 matrix + coverage artifacts)
49+
- For class-function coverage gate validation (when relevant to client changes),
50+
run:
51+
- `uv run python scripts/check_class_function_coverage.py coverage/py<version>/coverage.json --fail-under 90 --class PdfRestClient --class AsyncPdfRestClient --class _FilesClient --class _AsyncFilesClient`
52+
- Always report:
53+
- files changed
54+
- tests/checks run and not run
55+
- why any checks were skipped
56+
3357
## Coding Style & Naming Conventions
3458

3559
- Target Python 3.10–3.14; use 4-space indentation and type hints for public

0 commit comments

Comments
 (0)