docs: define the pre-1.0 stability and deprecation contract - #282
Open
dgenio wants to merge 2 commits into
Open
Conversation
dgenio
marked this pull request as ready for review
August 11, 2026 06:11
This was referenced Aug 11, 2026
There was a problem hiding this comment.
Pull request overview
Warning
Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.
Defines Weaver Kernel’s pre-1.0 stability/deprecation contract and updates contributor guidance so public/security-sensitive changes include an explicit compatibility and migration story.
Changes:
- Added
docs/versioning.mdto document what counts as public API, pre-1.0 SemVer interpretation, deprecation windows, and security-driven “fail-closed” breaks. - Updated
CONTRIBUTING.mdto require explicitly identifying compatibility surfaces (public API, wire/machine contracts, integrations, Security Contract) and to avoid preserving unsafe behavior for compatibility.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/versioning.md | Introduces the project’s stability/deprecation policy, including security- and integration-compatibility expectations. |
| CONTRIBUTING.md | Adds contributor requirements to consult the policy/contract and document compatibility + migration rationale for breaking or security-sensitive changes. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+32
to
+33
| ### Minor release: `0.x → 0.(x+1)` | ||
|
|
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.
Progresses #145 (the ROADMAP portion already landed in #276).
What changed
Adds
docs/versioning.mddefining:weaver_kernel.__all__+ explicitly documented public submodules);Updates
CONTRIBUTING.mdso public/security-sensitive changes must identify their compatibility/migration story and must not preserve unsafe behavior solely to avoid a break.Why
Pre-1.0 should permit deliberate contract evolution, not surprise churn. Security defaults are especially important: a fail-open or invariant-violating behavior should be fixed even when that is breaking, but the migration/release story must be explicit.
Remaining #145 scope
ROADMAP.md+ README roadmap link are already complete via docs: define security contract and adoption-gated roadmap #276.