Pre PR Verification
Testing & Qualitypre-pr-verificationPre PR Verification is an Agent Skill for testing & quality published in the rommapp/romm repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
The before-handoff / before-PR verification gate for RomM, covering both stacks. Use right before committing, opening a PR, or telling the user a change is done — to run the right static checks, tests, and (for UI) manual browser/theme/input/Storybook checks so CI stays green. Covers frontend (typecheck/lint/test/build/i18n/tokens), backend (pytest/alembic/trunk), and the OpenAPI regen step. Trigger when wrapping up any change.
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/rommapp/romm/blob/HEAD/.claude/skills/pre-pr-verification/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/pre-pr-verification, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
RomM — Verification Before Handoff
Run the checks that match what you touched. Static checks don't prove a feature works — when UI changed, also test it in the browser. Mirror the CI gates so review isn't the first place a failure shows up. Never --no-verify.
Frontend (frontend/)
Run from frontend/:
npm run typecheck— zero errors (vue-tsc --noEmit).npm run lint(if present) / ESLint clean. Trunk also runs ESLint + Prettier in CI.npm run test— zero failures (Vitest + happy-dom; runs unit tests and every/libstory'splay()viacomposeStories).npm run build— zero failures (CI sanity check).
If you touched the backend API: start the backend, run npm run generate, then re-typecheck.
If you touched tokens (src/v2/tokens/index.ts): npm run build:tokens (also auto-runs on predev/prebuild) and confirm tokens.css regenerated.
If you touched locales (src/locales/**): python3 frontend/src/locales/check_i18n_locales.py must pass with zero missing/extra keys. See the frontend-i18n skill.
UI manual pass (when changes are visible) — v2
With uiVersion = "v2":
- Golden path + edge cases: empty, error, loading, no-permission, extreme data; plus nearby regressions.
- Both themes:
v2-darkandv2-light. - All four input modalities: mouse, touch, keyboard, gamepad — focus ring only on
key/pad. - Responsive sweep: 320px → 4K across the
useBreakpointtiers; overlays full-bleed onxs. - Accessibility: contrast, keyboard reachability with no traps, aria-labels on icon-only controls.
- Performance: lists/grids of 1000+ items stay smooth; every
v-forhas a stable:key.
Storybook (for /lib)
- New primitive → mandatory story with controls + at least one variant per theme; interactive ones get a
play(). - Modified primitive → existing story still renders and interactions still pass.
- Don't duplicate coverage between Vitest (pure logic) and Storybook
play()(components).
Backend (backend/)
Run from backend/:
uv run pytest [path/file]— zero failures (run the affected subset, or all with-vv).trunk fmt && trunk check— ruff/black/isort/mypy/bandit clean (CI enforces Trunk).- If you added a migration:
uv run alembic upgrade headthenuv run alembic downgrade -1to prove both directions; it must work on MariaDB and PostgreSQL (CI runs both). - If a response schema or route signature changed: regenerate frontend types (
npm run generate) and typecheck the frontend.
CI gates this mirrors
typecheck.yml (vue-tsc + lockfile lint), frontend.yml (vitest + build), i18n.yml (locale check), pytest.yml (pytest on MariaDB + PostgreSQL), migrations.yml (alembic on both DBs), trunk-check.yml (Trunk across the repo). Green locally → green in CI.
Don't
- Open a PR without manually testing the UI when UI was touched.
--no-verifyon commits.- Leave a locale key English-only, a token un-generated, or a migration one-directional.