Skip to content

Add ExecPlan for wireframe-verification crate (15.1.2)#526

Draft
leynos wants to merge 1 commit intomainfrom
plan-wireframe-verification-w28fi2
Draft

Add ExecPlan for wireframe-verification crate (15.1.2)#526
leynos wants to merge 1 commit intomainfrom
plan-wireframe-verification-w28fi2

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Apr 21, 2026

Summary

This PR adds the living ExecPlan document for the planned wireframe-verification crate (15.1.2). The plan codifies constraints, tolerances, risks, progress tracking, decisions, and a staged approach to introducing the crates/wireframe-verification workspace member. This is an planning artifact only; no code changes are included yet. Approval is required to begin implementation.

Changes

  • Add new ExecPlan: docs/execplans/15-1-2-wireframe-verification-crate.md.
  • Document scope, constraints, risks, progress tracking, decision log, outcomes, and a staged plan (A–E) to implement the crate scaffolding and verification harness.
  • Outline acceptance signals and validation approach to ensure the plan is auditable and gating is explicit.

Rationale

The 15.1.2 plan introduces the first dedicated formal-verification crate (crates/wireframe-verification) and outlines how it should integrate with the existing workspace without widening the public API of the root wireframe package. This ExecPlan serves as a formal, approval-gated blueprint guiding the initial scaffold, tests, and documentation updates.

Plan of work (Stage A–E)

  • Stage A: Confirm the 15.1.2 contract
    • Audit delta from 15.1.1, verify root workspace shape, and confirm workspace-metadata expectations.
    • Decide minimal manifest for crates/wireframe-verification, ensure internal-only layout and no public surface.
    • Resolve whether a tiny shared helper module is required or if a pure connection_model module suffices.
  • Stage B: Scaffold the verification crate
    • Add workspace member: crates/wireframe-verification with publish = false.
    • Create minimal Cargo.toml, crate root (src/lib.rs), and a small connection_model module tree.
    • Implement a placeholder Stateright model to exercise crate wiring and dependencies.
    • Acceptance: cargo test -p wireframe-verification compiles and runs a placeholder model.
  • Stage C: Add regression coverage
    • Introduce rstest tests for the shared harness and placeholder model.
    • Update workspace manifest tests to reflect new member while keeping root as the default member.
    • Extend BDD-style tests to cover workspace contract changes via rstest-bdd.
    • Acceptance: tests pass and workspace contract remains intact.
  • Stage D: Update design and contributor documentation
    • Align docs with the new crate layout: update docs/formal-verification-methods-in-wireframe.md and docs/developers-guide.md.
    • Review docs/users-guide.md for consumer impact and log any changes.
    • Mark roadmap item 15.1.2 as done after code/tests pass.
  • Stage E: Validate and capture evidence
    • Run repository gates (fmt, tests, lint, docs, etc.) and capture logs.
    • Record evidence in the ExecPlan and update outcomes section accordingly.

Validation notes

  • The plan emphasizes explicit gating: no code changes occur until approval is received.
  • Acceptance signals and stage gates are defined within the plan to ensure traceability.
  • Documentation references in the plan point to existing guidance documents to keep consistency.

Documentation impact

  • The ExecPlan itself documents the intended changes and course of action.
  • Post-approval, the implementation will affect workspace manifests, crate layout, and contributor/docs references as outlined in Stage D.

How to review

  • Review the proposed Stage A–E tasks for alignment with project goals and current constraints.
  • Provide any clarifications or adjustments to the staged plan before authorizing Stage B execution.
  • Confirm that the 15.1.2 numbering and cross-references align with the current roadmap and design docs.

Approval gate

This plan is currently in DRAFT. Please provide explicit approval to begin Stage B (scaffolding the verification crate) and move the ExecPlan into IN PROGRESS. Subsequent updates to Progress, Decision Log, and Surprises & Discoveries will be recorded as work proceeds.

◳ Generated by DevBoxer


ℹ️ Tag @devboxerhub to ask questions and address PR feedback

📎 Task: https://www.devboxer.com/task/7849551b-1b21-4381-a196-34d9041706d2

Summary by Sourcery

Documentation:

  • Add a living ExecPlan markdown document describing constraints, risks, staged work plan, validation gates, and documentation updates for the planned wireframe-verification crate.

…erification models

Introduce `crates/wireframe-verification` as the repository’s first dedicated formal-verification crate. This internal workspace member hosts Stateright models and a shared test harness to enable upcoming verification work without expanding the user API or mixing with other verification tools. The root workspace includes this crate while retaining the main `wireframe` package as the only default member. Initial placeholder models and test infrastructure using `rstest` and `rstest-bdd` validate the new workspace shape and build/test ergonomics. Related design and contributor documentation is updated accordingly.

This foundational infrastructure prepares for later roadmap tasks adding deeper formal verification coverage.

Co-authored-by: devboxerhub[bot] <devboxerhub[bot]@users.noreply.github.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 21, 2026

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 5f5aec11-bb67-4851-bb62-be95d26e67d5

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch plan-wireframe-verification-w28fi2

Comment @coderabbitai help to get the list of available commands and usage tips.

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Apr 21, 2026

Reviewer's Guide

Adds a new ExecPlan markdown document describing the staged implementation plan for introducing the internal crates/wireframe-verification Stateright crate, without making any code or workspace changes yet.

File-Level Changes

Change Details Files
Introduce a living ExecPlan document for roadmap item 15.1.2 to guide creation of the internal wireframe-verification crate and its verification harness.
  • Add status-tracked ExecPlan with sections for constraints, tolerances, risks, progress, discoveries, decisions, and outcomes.
  • Define observable success criteria and acceptance signals tied to Cargo workspace behavior and test commands.
  • Specify constraints on workspace shape, crate visibility, testing approach, and documentation updates for the future crate implementation.
docs/execplans/15-1-2-wireframe-verification-crate.md
Define a staged implementation plan (Stages A–E) and validation/evidence requirements for the future verification crate work.
  • Detail Stage A–E tasks covering contract confirmation, crate scaffolding, regression coverage, documentation alignment, and final validation.
  • Document approval gating: no implementation work may start until the ExecPlan moves from DRAFT to APPROVED/IN PROGRESS.
  • List concrete validation commands, logging expectations, and evidence to capture during later stages, including workspace-level tests and Makefile gates.
docs/execplans/15-1-2-wireframe-verification-crate.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant