apunkt/mike
1
0
Fork 0
mirror of https://github.com/willchen96/mike.git synced 2026-07-24 23:41:04 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
mike/CONTRIBUTING.md
QA Runner 15b7b4c925 docs: testing policy in CONTRIBUTING + PR template with verification 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/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>
2026-07-20 10:46:47 -07:00

2.8 KiB
Raw Blame History

Contributing

Thanks for helping improve Mike. Please keep contributions small, focused, and easy to review.

Guidelines

  • Prefer targeted edits over broad refactors.
  • Keep each PR focused on one bug, feature, or cleanup.
  • Update docs or env examples when changing setup, config, or user-facing behavior.
  • Please do not propose local-hosting refactors for the main app, such as local LLMs, local databases, or local filesystem storage. Those ideas are better suited to a future fully local version of the project.
  • Do not commit secrets, API keys, private documents, or local .env files.

Before Opening a PR

  • Run the relevant build or test command for the area you changed.
  • Check git diff and remove unrelated changes.
  • Write a concise Markdown PR description with:
    • summary
    • changes
    • why
    • testing

System Workflows

System workflows live in the sibling Open-Legal-Products/mike-workflows repository under assistant-workflows/ and tabular-review-workflows/. Put structured metadata in the YAML frontmatter at the top of SKILL.md, set metadata.mike-availability to system, put workflow instructions in the body of SKILL.md, and use table-columns.yaml for tabular review columns.

After changing system workflows, regenerate the app files:

node scripts/build-workflows.js

Security

Do not open a public issue for security vulnerabilities. Use GitHub's private vulnerability reporting instead.

We will aim to respond promptly and coordinate a disclosure timeline with you.

Local Development

Backend:

npm run build --prefix backend

Frontend:

npm run build --prefix frontend

Testing

npm test --prefix backend            # backend unit + route integration tests (vitest)
npm test --prefix frontend           # frontend component/hook tests (vitest + jsdom)
npm run test:e2e                     # Playwright end-to-end suite — see docs/e2e-ci.md
node evals/run.mjs --threshold 1.0   # offline eval harness (no network, no API keys)
npm run test:stack --prefix backend  # gated: real-Supabase auth/access tests (run `supabase start` first)
  • New features and bug fixes should come with a test at the lowest layer that can catch the regression: unit first, then route-level integration, then end-to-end only for flows a browser is genuinely needed to prove.
  • CI runs the build, unit/integration tests, and the eval harness on every PR (.github/workflows/ci.yml), and the Playwright suite in a full local stack (.github/workflows/e2e.yml).
  • Tests that need a live Supabase or an LLM key are env-gated and skip cleanly when the environment is absent — a plain npm test should always be green.