Skip to content

Document version support policy#1855

Merged
mootz12 merged 5 commits into
mainfrom
doc-version-support-policy
May 6, 2026
Merged

Document version support policy#1855
mootz12 merged 5 commits into
mainfrom
doc-version-support-policy

Conversation

@leighmcculloch
Copy link
Copy Markdown
Member

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.

@leighmcculloch leighmcculloch marked this pull request as ready for review April 28, 2026 13:44
Copilot AI review requested due to automatic review settings April 28, 2026 13:44
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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-sdk crate-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.

Comment thread README.md
Comment thread soroban-sdk/src/lib.rs
Comment thread soroban-sdk/README.md
@tupui
Copy link
Copy Markdown

tupui commented Apr 28, 2026

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

@leighmcculloch
Copy link
Copy Markdown
Member Author

Could you here or later also consider adding some notes about the deprecation policy and what constitute a breaking change and what not.

Opened:

@claude
Copy link
Copy Markdown

claude Bot commented Apr 29, 2026

Claude finished @leighmcculloch's task in 53s —— View job


PR Review

  • Gather context and read changed files
  • Review changes for correctness, consistency, and quality
  • Post review feedback

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:

  • README.md:14
  • soroban-sdk/README.md:16
  • soroban-sdk/src/lib.rs:16

Current:

General bugs are only fixed on, and new features are only added to, the latest major release.

Should be:

General bugs are only fixed in, and new features are only added to, the latest major release.

Fix this →

Everything else looks good:

  • Heading levels are consistent within each file (## in root README, ### in crate README and lib.rs)
  • Text is identical across all three locations — no drift between docs/README/lib.rs
  • Placement of the section is logical in each file
  • The policy itself ("two most recent major releases get security fixes; only latest gets bug fixes and features") is clear and sets appropriate user expectations

@mootz12 mootz12 added this pull request to the merge queue May 6, 2026
Merged via the queue into main with commit 568711d May 6, 2026
199 checks passed
@mootz12 mootz12 deleted the doc-version-support-policy branch May 6, 2026 13:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants