Skip to content

Establish an evidence-driven Workshop conformance corpus and seasonal feature census #10

Description

@Teakowa

Goal

Establish a durable Workshop conformance corpus that turns real projects, minimized regressions, a canonical full-feature Workshop census, and periodic live-client observations into executable evidence for workshop-rs and downstream language implementations.

Context

workshop-rs owns the canonical Workshop capability identities and Workshop-observable expectations used by this corpus. Source-language repositories remain responsible for their own syntax, semantics, and source-level fixtures.

The corpus must make correctness expectations independently attributable and must distinguish implementation regression evidence from externally grounded or preserved behavioral evidence.

Scope

  • Define a provenance-aware fixture model that distinguishes at least:
    • small synthetic/unit or property cases;
    • minimized regressions extracted from real projects;
    • complete real-world project/corpus cases;
    • live-client/seasonal observations.
  • Require correctness expectations to identify an independent evidence source such as a Workshop client observation, pinned external oracle, documented semantic contract, or preserved real-project regression. Do not treat implementation output changed in the same patch as independent correctness evidence.
  • Preserve minimized reproductions for real-project semantic/compatibility defects where practical while retaining repository/revision/path provenance and the original full-project evidence.
  • Define stable Workshop feature identities for conformance results across the declared semantic/catalog surface.
  • Maintain a canonical Workshop feature-census fixture/mode that exercises the declared surface and reports failures by feature identity rather than only as a monolithic script diff.
  • Use semantic/normalized equivalence as the correctness target where text identity is not part of the contract.
  • Provide machine-readable conformance output that distinguishes matched behavior, unsupported surface, known gaps, unexpected regression/divergence, and inconclusive evidence without counting known failures as passing compatibility.
  • Define a repeatable seasonal validation workflow in which census artifacts can be round-tripped through the live Overwatch client with game/season/client-locale/catalog provenance.
  • Use English client output as the primary semantic baseline where appropriate, with explicit locale sweeps for localization/catalog drift as separately recorded evidence.
  • Keep corpus/result contracts reusable by opy-rs and deltin-rs without transferring canonical Workshop ownership out of this repository.

Non-goals

  • Claiming exhaustive live-runtime/gameplay correctness solely from import/export evidence.
  • Requiring byte-identical or formatting-identical output.
  • Building a network service or automatically downloading unreviewed catalog data at runtime.
  • Moving OPY or DEL/OSTW source-language fixtures or semantics into workshop-rs.
  • Treating one giant census script as a replacement for focused unit/property tests or real-world projects.
  • Freezing a separate cross-repository test framework before concrete corpus integration requires one.
  • Maintaining child-issue completion state or execution sequencing in this parent issue body.

Acceptance criteria

  • The repository documents and enforces an evidence model in which correctness expectations have traceable provenance independent from the implementation being changed.
  • Real-project failures can retain project-level provenance and, where valuable, minimized provenance-linked regression fixtures.
  • A canonical feature-census fixture covers the declared Workshop semantic/catalog surface with stable machine-readable feature identities.
  • Census failures identify affected features rather than reducing the result to a single whole-file pass/fail.
  • parse -> canonical semantics -> emit and supported locale conversion are gated against the corpus using semantic/normalized contracts.
  • Known gaps are represented explicitly and are not reported as successful parity/conformance.
  • A documented seasonal client-validation procedure records client/game/catalog/locale provenance and supports structured comparison with prior captures.
  • The resulting corpus/result contracts can be consumed by opy-rs and deltin-rs without transferring canonical Workshop ownership out of this repository.

Relationships

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions