docs(readme): add Install, Stability and versioning sections for v1 - #1802
Merged
Conversation
Documents the v1.0.0 SemVer commitment and the deprecate-don't-delete policy so consumers know what to expect from the v1 line. Adds an explicit Install section with the minimum supported Go version (1.26) and points migrators at the docs site for v1 release notes and migration guide. Linear: OSS-3393
james00012
marked this pull request as ready for review
April 27, 2026 01:45
PR #1803 places the migration guide at root-level MIGRATION.md rather than the docs site. Update the README link accordingly so readers reach the actual content. Linear: OSS-3393
denis256
approved these changes
Apr 28, 2026
james00012
enabled auto-merge
April 28, 2026 16:33
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
2 participants
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
Adds two new README sections ahead of v1.0.0:
go getcommand and minimum supported Go version (1.26)Note on the CircleCI badge
PR #1796 already removes the dead CircleCI badge from this README. To avoid a merge conflict, this PR doesn't touch it. Whichever PR lands second will rebase trivially.
Diff
1 file changed, +18/-1.
Linear: OSS-3393