Skip to content

docs(engineering): road-to-1.0.0 release checklist#98

Merged
doubleailes merged 1 commit into
mainfrom
docs/road-to-1.0.0
May 19, 2026
Merged

docs(engineering): road-to-1.0.0 release checklist#98
doubleailes merged 1 commit into
mainfrom
docs/road-to-1.0.0

Conversation

@doubleailes
Copy link
Copy Markdown
Owner

Summary

Adds docs/content/docs/engineering/road-to-1.0.0.md — companion
to the existing
Stability commitments
page. The stability page describes what 1.0 commits us to; this
new page describes the work needed before cutting 1.0 so the
commitment is defensible.

Docs-only. No code or API changes.

What's in the doc

Structured as a four-week sequence of small PRs:

Week Theme Sample items
1 API surface freeze drop filters / max_iterations reserved kwargs, deprecate SolveResult.resolved, audit Rust pub items, add #[non_exhaustive] to public enums, decide FamilyLoader / VersionRange exposure
2 Correctness net extract ~200-pkg fixture corpus, wire compare_resolves.py into CI, scaffold property/fuzz tests, triage open issues (#96 in particular)
3 Documentation stability page lists exact public symbols, README drops experimental framing, changelog retitled [1.0.0] — <date>
4 Release bump pins, verify wheel + crates publish flows, tag, announce

Plus an explicit "What's not in 1.0" section to resist scope
creep: the Rex evaluator, persistent caches, parallel
solve_many, and daemon model are all 1.1+ work. The 1.0 bar
isn't more features — it's confidence we can support what's
already shipped.

Sign-off conditions at the end list the 6 must-be-true items
before tagging. If any aren't, ship another rc instead.

Test plan

  • Docs build under Zola (no broken anchor links — only
    references go to the existing stability page which is on
    main)
  • Read through, edit anything that's mis-framed
  • Merge to land the plan as the canonical roadmap

🤖 Generated with Claude Code

Companion to the existing Stability commitments page. The
stability page describes what 1.0 commits us to; this new page
describes the work needed *before* cutting 1.0 so the commitment
is defensible.

Structured as a four-week sequence of small PRs:

1. API surface freeze — drop `filters` / `max_iterations`
   reserved-but-ignored kwargs, deprecate `SolveResult.resolved`,
   audit Rust `pub` items, add `#[non_exhaustive]` to public
   enums, decide the `FamilyLoader` / `VersionRange` exposure
   question.
2. Correctness net — extract a ~200-package fixture corpus, wire
   `compare_resolves.py` into CI, scaffold property/fuzz tests
   on the solver, triage open issues (including #96).
3. Documentation — stability page lists exact public symbols
   (not qualitative claims), README drops experimental framing,
   changelog retitled.
4. Release — bump pins, verify wheel + crates publish flows,
   tag, announce.

Explicit "what's not in 1.0" section to resist scope creep:
the Rex evaluator, persistent caches, parallel solve_many, and
daemon model are all 1.1+ work. The 1.0 bar isn't more features —
it's confidence we can support what's already shipped.

Closes the planning loop around the release.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@qodo-code-review
Copy link
Copy Markdown

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

@doubleailes doubleailes merged commit a2e542c into main May 19, 2026
46 of 57 checks passed
@doubleailes doubleailes deleted the docs/road-to-1.0.0 branch May 19, 2026 10:33
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