[Docs 02] docs: testing policy in CONTRIBUTING + PR template

✅ merged · #234 · open-legal-products/mike ← amal66/mike · opened 3mo ago by amal66 · merged 3mo ago by willchen96 · +49 across 2 files · ↗ on GitHub

From the PR description

Summary

Contributor-facing testing policy: a Testing section in CONTRIBUTING.md and a PR template whose checklist asks how the change was verified. The capstone of the testing series - it documents the commands the sibling PRs introduce.

Changes

  • CONTRIBUTING.md - new Testing section: how to run each suite (npm test in backend//frontend/, npm run test:e2e, node evals/run.mjs, the gated test:stack real-Supabase suite), the expectation that features/fixes carry a test at the lowest layer that can catch the regression, and the rule that env-gated tests must skip cleanly so plain npm test is always green.
  • .github/PULL_REQUEST_TEMPLATE.md - summary / why / changes / tradeoffs / how verified structure with a short checklist, matching the PR-description format CONTRIBUTING already asks for.

Why

The repo's testing story only sticks if contributors know it exists and are asked to participate in it. Today CONTRIBUTING says "run the relevant build or test command" but there is nothing to run; once the series lands, this makes the expectation concrete.

Merge order

Best merged last in the series, after the suites it references exist: #228 (harness), #229 (backend unit), #230 (frontend unit), #231 (evals), #232 (CI), #220 (e2e), and #233 (route integration). Merging it earlier is harmless - the documented commands simply arrive as their PRs land.

Testing

Docs-only; rendered and proofread. Commands verified against the sibling branches they document.

🤖 Generated with Claude Code

Our analysis

Document testing policy and verification expectations — read the full analysis →

Think the analysis missed something the PR description covers?

Commits in this PR (1)

SHA Subject Author Date
15b7b4c9 docs: testing policy in CONTRIBUTING + PR template with verification checklist QA Runner 2026-07-20 ↗ GitHub
commit body
Adds a Testing section documenting every suite the testing PR series
introduces (unit/integration via vitest, Playwright e2e, offline evals,
gated real-Supabase stack tests), the expectation that changes carry tests
at the lowest layer that catches the regression, and a PR template (ported
from the amal66 fork, Open-Legal-Products/mike#205) whose checklist asks how
the change was verified. Intended as the capstone of the series - the
commands it documents are introduced by the sibling test PRs.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Capture this PR into my fork

Download a Markdown prompt that tells Claude how to port every commit in this PR into your working tree. Run it via claude -p < capture-pull-234.md from inside the repo you want the changes in.

⬇ Download capture-pull-234.md