Skip to content

Proposal: add canonical verify command + dependency preflight gate #708

@gh-xj

Description

@gh-xj

Background

OpenWork has verification expectations spread across docs (AGENTS.md, README, workflow files), but there is no single canonical local verification command that contributors can run before opening a PR.

Recent PR iterations also exposed runtime mismatch risk (for example, script paths that may assume tools not present in CI).

Proposal

Add a single canonical verification gate for this repo and make dependency preflight explicit.

Scope

1) Canonical verify command

Introduce one command (pnpm verify or task verify) that runs the repo baseline checks in a stable order, for example:

  • format/lint (if configured)
  • typecheck
  • app/server tests
  • e2e subset used for PR confidence

2) Dependency preflight

Add an early check that validates required runtimes/tools used by verify gates and CI (Node, pnpm, Rust/Tauri where needed, opencode, and any optional tool expectations).

If a dependency is missing, fail early with actionable guidance.

3) Docs alignment

Update README.md + AGENTS.md command references so contributors and agents use the same canonical verify command.

4) CI alignment

Ensure CI and local verify run equivalent gates to minimize "passes locally/fails in CI" drift.

Why this helps

  • Reduces contributor uncertainty about what “ready for PR” means
  • Lowers maintenance overhead from ad-hoc command choices
  • Catches environment/runtime mismatch earlier

Acceptance criteria

  • One canonical verify command exists and is documented
  • Verify command runs required baseline gates end-to-end
  • Dependency preflight exists with clear failure messages
  • README and AGENTS references are aligned to the same command
  • CI gate mapping to local verify is documented (or directly shared)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions