[Docs 02] docs: testing policy in CONTRIBUTING + PR template - #234
Merged
Conversation
…checklist 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#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>
|
QA Runner seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
amal66
changed the title
amal66
changed the title
amal66
changed the title
amal66
changed the title
willchen96
approved these changes
Jul 21, 2026
Collaborator
|
Looks good! |
duncanmcqueen
pushed a commit
to duncanmcqueen/mike
that referenced
this pull request
Aug 3, 2026
…-docs [Docs 02] docs: testing policy in CONTRIBUTING + PR template
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Contributor-facing testing policy: a Testing section in
CONTRIBUTING.mdand 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 testinbackend//frontend/,npm run test:e2e,node evals/run.mjs, the gatedtest:stackreal-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 plainnpm testis 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