docs: add CHANGELOG.md and "Stability commitments" page for 1.0#83
Merged
Conversation
Last two items on the Option A 1.0 checklist: - A CHANGELOG.md following Keep a Changelog conventions, covering every rc release back to rc.1, plus a 1.0.0 entry capturing the variant-index parity (#81) and `intersection_priority` (#82) work. Includes compare-links pointing at the conventional tag names. - A new docs page `engineering/stability.md` that articulates exactly what 1.0 commits us to: - Versioning: workspace + wheel bumped in lock-step; semver as of 1.0; the rc.x series carried no contract. - Stable API: explicit list of the Python and Rust surface that's covered by semver, and an equally explicit list of what isn't (the `solver_micro` benches, the rez_solver submodule layout, `Reduction` / failure detail wording, internal performance characteristics). - Supported Pythons: 3.9–3.13 today (one abi3-py39 wheel per platform / architecture covers all of them), 3.14 when pyo3 catches up. - Supported rez: doesn't import rez; the `PackageData.from_rez` helper is exercised against rez 3.3.0 (vendored submodule) and via the 188-case differential. - Correctness contract: same `(name, version)` set as rez, same variant index, same status — divergence on any is a release blocker. - What's modelled vs not: a single table mapping each rez feature to "supported" or "not supported, fall back to rez." - Performance is explicitly NOT in the contract — the `solver_micro` baselines catch regressions on internal hot paths, not absolute numbers. - Breaking-change policy: RFC issue → addition with deprecation → one MINOR cycle → removal at MAJOR. - Regression reporting flow. The CHANGELOG entry for the `Unreleased` / `1.0.0` is intentionally specific about which PRs land in 1.0 so a reader of the file can trace each line back to a concrete change. Linked from: - README's new "Release notes & stability" section near the bottom. - The introduction page's "Next steps" list. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Qodo reviews are paused for this user.Troubleshooting steps vary by plan Learn more → On a Teams plan? Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Last two items on the Option A 1.0 checklist:
VariantSelectMode::intersection_priority#63) — feat(resolver): implementVariantSelectMode::intersection_priority(closes #63) #82.`CHANGELOG.md`
Follows Keep a Changelog conventions. Covers every rc release back to rc.1, plus a forthcoming 1.0.0 entry capturing the variant-index parity (#81) and `intersection_priority` (#82) work. Includes compare-links pointing at the conventional tag names.
Each entry is specific about which PRs / commits delivered the change so a reader can trace any line back to the concrete diff.
`engineering/stability.md`
New docs page articulating exactly what 1.0 commits us to:
Links
Verification
1.0 path complete
After this merges, the Option A checklist for 1.0.0 is:
Tagging 1.0.0 is a single `chore(release)` commit away (version bump in `Cargo.toml` + the docs version pill + the Quick Start dep example — same shape as every previous rc bump).
🤖 Generated with Claude Code