tests/ contains benchmark/, e2e/, and test_tokenization.py, but no README. New contributors can't tell which suite is which, what each one needs to run (model artifacts? a running proxy?), or which make target invokes it.
What to add
Create tests/README.md covering:
- Directory layout (
benchmark/, e2e/, root pytest files)
- What each suite tests and any prerequisites (e.g. proxy must be running, ONNX model present)
- How to run each suite individually (
uv run pytest tests/e2e/..., make test-all, etc.)
- How to add a new test in each layer (unit / e2e / benchmark)
Hints
- Look at
Makefile targets that touch tests/ to confirm which commands run what.
- Cross-link to
docs/02-development-guide.md.
Difficulty: good first issue, ~30–45 min.
tests/containsbenchmark/,e2e/, andtest_tokenization.py, but no README. New contributors can't tell which suite is which, what each one needs to run (model artifacts? a running proxy?), or whichmaketarget invokes it.What to add
Create
tests/README.mdcovering:benchmark/,e2e/, root pytest files)uv run pytest tests/e2e/...,make test-all, etc.)Hints
Makefiletargets that touchtests/to confirm which commands run what.docs/02-development-guide.md.Difficulty: good first issue, ~30–45 min.