Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Freeze lexvm-pack/1 with a compatibility promise and a golden-transcript conformance suite

Open
  • Is something wrong?
#59 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
typescript
Domain
backend, testing

Research direction

Start by reading docs/spec/content-pack.md sections 10 and 16 and Appendix A, then inspect packages/engine/test/ and the existing ADR at docs/adr/0004-yaml-source-json-runtime-zod-schema.md. The issue calls for a new conformance corpus and runner, CI coverage checks, spec/runtime review, a freeze ADR, and compatibility text in the spec and README. Done means the listed acceptance criteria are met, including coverage for every required case and diagnostic codes.

Written by the indexing model from the issue text.

Description

area: engine priority: high type: feature

Context

v1.0 promises that packs keep working. Some runtime behaviour was decided during implementation and only later written into the spec; without a mechanical check, spec and runtime drift. A conformance suite also allows other engine implementations.

Scope

  • conformance/: small packs, each with command logs and expected results (output blocks and spans as JSON, the final stateKey, view snapshots). At least one case per condition, effect, core verb default, event type, dialogue rule and rejection reason, and for the turn order of spec section 10.
  • A runner in the engine tests and as a script other implementations can use; a CI job.
  • Review the spec against the runtime; every case references the spec section it covers.
  • Compatibility promise in spec section 16 and the README: packs valid under lexvm-pack/1 at v1.0, and lexvm-save/1 saves, keep working in every 1.x engine; only additive changes; a deprecation policy. Diagnostic codes from the code registry (#38) are covered by the same promise.
  • An ADR for the freeze.

Acceptance criteria

  • The suite covers every condition, effect, core verb default and event; CI checks the coverage list.
  • Discrepancies between spec and runtime found by the review are fixed.
  • The freeze ADR is accepted and the spec status changes from "normative for LexVM 0.x" to frozen.
  • The compatibility promise, including diagnostic codes, is in spec section 16 and the README.

References

  • docs/spec/content-pack.md (sections 10 and 16, Appendix A)
  • packages/engine/test/
  • CHANGELOG.md
  • docs/adr/0004-yaml-source-json-runtime-zod-schema.md
Dominant language
TypeScript
Stars
0
Forks
0
Avg merge
28m
Merged PRs (30d)
2

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from nullthrone/lexvm

All issues in nullthrone/lexvm

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.