Document version support policy#1855
Conversation
There was a problem hiding this comment.
Pull request overview
Adds an explicit version support policy to the Soroban SDK’s primary user-facing entrypoints (crate docs + READMEs) so users understand what to expect regarding backports and maintenance.
Changes:
- Document support policy in
soroban-sdkcrate-level docs (lib.rs). - Add the same Support section to the crate README (
soroban-sdk/README.md). - Add the same Support section to the repository root README (
README.md).
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| soroban-sdk/src/lib.rs | Adds crate-level rustdoc “Support” policy section for docs.rs users. |
| soroban-sdk/README.md | Adds “Support” section to crate README to match published crate docs. |
| README.md | Adds “Support” section to the repo landing page README. |
|
It's a good first step. Could you here or later also consider adding some notes about the deprecation policy and what constitute a breaking change and what not. E.g. in SciPy we have a precise flow for that https://docs.scipy.org/doc/scipy/dev/core-dev/index.html#deprecations |
Opened: |
|
Claude finished @leighmcculloch's task in 53s —— View job PR Review
The PR is well-scoped and the policy text is clear and consistent across all three locations. One grammar issue needs fixing before merge. Grammar: "fixed on" → "fixed in" (all 3 files) The preposition "on" is incorrect when referring to a software release. It should be "in". This affects the same line in all three files:
Current: Should be: Everything else looks good:
|
What
Add a Support section to the repository README, crate README, and lib.rs documentation describing which soroban-sdk versions receive security fixes, bug fixes, and new features.
Why
Set clear expectations for users about which major releases are maintained, so they can plan upgrades and understand backport guarantees.