feat: document public API stability policy for v1.0.0#93
Merged
Conversation
Adds a Versioning section to README defining what is/isn't covered by semver guarantees from 1.0 onwards, the deprecation policy (warn in minor, remove in major), and cross-references UPGRADING.md. UPGRADING.md gains a brief stability guarantee note linking back to the README section. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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
1 participant
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.
Closes #51
Summary
## Versioningsection to the README defining the public API surface (config keys,mount_path,authenticate, metrics endpoint shape, Engine class, install generator), what is explicitly excluded (internal service classes, views, CSS, private methods), and the deprecation policy (warn in minor release, remove in next major)UPGRADING.mdgets a brief semver guarantee note cross-referencing the README sectionTest plan
bundle exec rspec— all examples pass (docs-only change)🤖 Generated with Claude Code