Standardize README prerequisites across all SDK languages#1636
Standardize README prerequisites across all SDK languages#1636scottaddie wants to merge 5 commits into
Conversation
Move the .NET README requirements section above installation, rename it to prerequisites, and clarify the runtime requirement as any .NET Standard 2.0-compatible implementation. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Reorganizes the .NET SDK README to surface runtime requirements up front and clarifies framework compatibility so users don’t incorrectly infer that .NET 8 is required for all use cases.
Changes:
- Adds a new Prerequisites section before Installation.
- Updates wording to state support for any .NET Standard 2.0-compatible implementation and links to Microsoft Learn guidance.
- Removes the older “Requirements” section previously located near the bottom of the README.
Show a summary per file
| File | Description |
|---|---|
| dotnet/README.md | Moves requirements into a Prerequisites section and clarifies .NET Standard 2.0 compatibility with an external reference link. |
Copilot's findings
- Files reviewed: 1/1 changed files
- Comments generated: 0
This comment has been minimized.
This comment has been minimized.
|
@copilot Update this PR to also address the suggestion in #1636 (comment) |
Co-authored-by: scottaddie <10702007+scottaddie@users.noreply.github.com>
Done. Applied the consistent
|
This comment has been minimized.
This comment has been minimized.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Generated by SDK Consistency Review Agent for issue #1636 · sonnet46 871.4K
|
@copilot update this PR to address the suggestions in #1636 (comment) |
Co-authored-by: scottaddie <10702007+scottaddie@users.noreply.github.com>
Done. Updated |
This comment has been minimized.
This comment has been minimized.
|
@copilot update this PR to address the pre-existing nit mentioned in #1636 (comment) |
Co-authored-by: scottaddie <10702007+scottaddie@users.noreply.github.com>
Fixed in the latest commit — removed the stray trailing period from |
This comment has been minimized.
This comment has been minimized.
|
@copilot update the PR to address the minor nitpick mentioned in #1636 (comment) |
Co-authored-by: scottaddie <10702007+scottaddie@users.noreply.github.com>
Done. Updated Node.js, Python, and .NET Prerequisites sections to use |
Cross-SDK consistency review ✅This PR now covers all six SDK READMEs consistently. Here is the final cross-SDK analysis of the current head:
All SDKs now:
Rust's CLI bullet uses a different structure ( Pre-existing note (not introduced by this PR):
|
|
|
||
| ## Prerequisites | ||
|
|
||
| - Any of the [.NET Standard 2.0-compatible .NET implementations](https://learn.microsoft.com/dotnet/standard/net-standard?tabs=net-standard-2-0#select-net-standard-version) |
There was a problem hiding this comment.
Building the SDK, which I expect what this is intending to refer to, actually requires a .NET 10 SDK or later.
stephentoub
left a comment
stephentoub
left a comment
There was a problem hiding this comment.
Other than the .NET issue, LGTM
The .NET README listed requirements near the bottom and implied .NET 8.0 was required, which could mislead users targeting other supported .NET implementations. Other SDK READMEs also lacked consistency in how and where prerequisites were presented.
This PR standardizes prerequisites presentation across all SDK READMEs:
## Requirements→## Prerequisitesand moves it before## Installation.### Runtime requirementssubsection (previously nested inside## Installation) to a top-level## Prerequisitessection placed before Installation.## Prerequisitessection before## Installationlisting the Go 1.24+ and CLI requirements.## Prerequisitessection before## Quick Startlisting the Rust 1.94.0+ requirement and noting the defaultbundled-clibehavior.