Standardize README prerequisites across all SDK languages by scottaddie · Pull Request #1636 · github/copilot-sdk

scottaddie · 2026-06-11T21:50:16Z

SDK READMEs lacked consistent structure and placement for prerequisites. The .NET README also incorrectly listed the CLI as a prerequisite despite the SDK bundling it.

Changes

All SDKs: Add "To use the SDK:" lead-in sentence before the prerequisites bullet list in dotnet, nodejs, python, go, rust, and java READMEs
.NET: Remove the CLI installation bullet from Prerequisites — the .NET SDK bundles the CLI, so it is not a consumer requirement
.NET: Move Prerequisites above Installation; clarify any .NET Standard 2.0-compatible implementation is supported (not just .NET 8)
Node.js / Python: Rename ## Requirements → ## Prerequisites; move before ## Installation
Java: Promote ### Runtime requirements (nested under Installation) to a top-level ## Prerequisites section
Go / Rust: Add new ## Prerequisites sections before Installation / Quick Start

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>

Copilot

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

scottaddie · 2026-06-11T21:59:23Z

@copilot Update this PR to also address the suggestion in #1636 (comment)

Co-authored-by: scottaddie <10702007+scottaddie@users.noreply.github.com>

Copilot · 2026-06-11T22:05:27Z

@copilot Update this PR to also address the suggestion in #1636 (comment)

Done. Applied the consistent ## Prerequisites pattern across all SDK READMEs in commit Apply consistent Prerequisites sections across all SDK READMEs:

Node.js: renamed ## Requirements → ## Prerequisites, moved before ## Installation
Python: same as Node.js
Java: promoted the ### Runtime requirements subsection (inside Installation) to a top-level ## Prerequisites section placed before Installation
Go: added a new ## Prerequisites section before ## Installation listing Go 1.24+ and CLI requirements
Rust: added a new ## Prerequisites section before ## Quick Start listing Rust 1.94.0+ and noting the bundled-cli default

github-actions

Generated by SDK Consistency Review Agent for issue #1636 · sonnet46 871.4K

scottaddie · 2026-06-11T22:34:21Z

@copilot update this PR to address the suggestions in #1636 (comment)

Co-authored-by: scottaddie <10702007+scottaddie@users.noreply.github.com>

Copilot · 2026-06-11T22:38:05Z

@copilot update this PR to address the suggestions in #1636 (comment)

Done. Updated python/README.md to change "GitHub Copilot CLI installed and accessible" to "GitHub Copilot CLI installed and in PATH (or provide a custom connection=RuntimeConnection.for_stdio(path=...))". This now matches the specificity pattern used by all other SDK READMEs.

scottaddie · 2026-06-11T22:45:08Z

@copilot update this PR to address the pre-existing nit mentioned in #1636 (comment)

Co-authored-by: scottaddie <10702007+scottaddie@users.noreply.github.com>

Copilot · 2026-06-11T22:48:10Z

@copilot update this PR to address the pre-existing nit mentioned in #1636 (comment)

Fixed in the latest commit — removed the stray trailing period from 1.0.55-5. → 1.0.55-5 in java/README.md.

scottaddie · 2026-06-11T22:54:27Z

@copilot update the PR to address the minor nitpick mentioned in #1636 (comment)

Co-authored-by: scottaddie <10702007+scottaddie@users.noreply.github.com>

Copilot · 2026-06-11T22:57:53Z

@copilot update the PR to address the minor nitpick mentioned in #1636 (comment)

Done. Updated Node.js, Python, and .NET Prerequisites sections to use `PATH` (code-formatted), matching Go and Java.

stephentoub

Other than the .NET issue, LGTM

…SDK READMEs Co-authored-by: scottaddie <10702007+scottaddie@users.noreply.github.com>

scottaddie · 2026-06-15T15:41:56Z


 ## Prerequisites

+To use the SDK:


@copilot In each of the language files, update the "To use the SDK:" text to "To use the SDK, you'll need:"

Done — updated all six SDK READMEs to use "To use the SDK, you'll need:" in the latest commit.

…READMEs Co-authored-by: scottaddie <10702007+scottaddie@users.noreply.github.com>

edburns

LGTM for Java

stephentoub · 2026-06-15T17:11:11Z


 - Java 17 or later. **JDK 25 recommended**. The distributed jar is a multi-release jar (MR-JAR) and is compiled on JDK 25 with `maven.compiler.release` set to 17. This means, when run on JDK 25 and later, the SDK automatically uses virtual threads for its default internal executor.
- GitHub Copilot CLI 1.0.55-5. or later installed and in `PATH` (or provide custom `cliPath`)
+- GitHub Copilot CLI 1.0.55-5 or later installed and in `PATH` (or provide custom `cliPath`)


Do we not bundle it with Java as well?

stephentoub · 2026-06-15T17:11:36Z

+To use the SDK, you'll need:
+
+- Node.js ^20.19.0 or >=22.12.0
+- GitHub Copilot CLI installed and in `PATH` (or provide a custom `connection`)


Don't we bundle it for node as well?

stephentoub · 2026-06-15T17:11:46Z

+To use the SDK, you'll need:
+
+- Python 3.11+
+- GitHub Copilot CLI installed and in `PATH` (or provide a custom `connection=RuntimeConnection.for_stdio(path=...)`)


Don't we bundle it for python as well?

stephentoub · 2026-06-15T17:12:10Z

+To use the SDK, you'll need:
+
+- Rust 1.94.0 or later
+- GitHub Copilot CLI: bundled by default via the `bundled-cli` feature (see [Features](#features)); or supply via `COPILOT_CLI_PATH`


Why do we need to list it as a prereq given that it's bundled by default?

github-actions · 2026-06-15T17:13:16Z

Cross-SDK consistency review ✅

This PR does an excellent job standardizing prerequisites structure across all six SDK implementations. Here's the consistency checklist:

Check	Result
All 6 SDKs have a `## Prerequisites` section	✅
Consistent lead-in: "To use the SDK, you'll need:"	✅
Section placed before Installation / Quick Start	✅
.NET and Rust correctly omit the CLI requirement (bundled)	✅
`PATH` consistently formatted as inline code	✅

One minor observation (pre-existing, not introduced by this PR): java/README.md specifies a minimum CLI version (1.0.55-5 or later), while nodejs, python, and go READMEs list the CLI as a requirement without a version constraint. This was already present before this PR — it's just been moved from under ## Installation to the new ## Prerequisites section. If a minimum CLI version is meaningful for Java specifically, keeping it is fine; if it's meant to be universal, the other SDKs could eventually document the same floor. Either way, it's out of scope for this PR.

Overall, the structural changes are clean, symmetric, and consistently applied. No cross-SDK gaps to address.

Generated by SDK Consistency Review Agent for issue #1636 · sonnet46 674.3K · ◷

Update .NET README prerequisites

43e6fdb

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>

Copilot AI review requested due to automatic review settings June 11, 2026 21:50

scottaddie requested a review from a team as a code owner June 11, 2026 21:50

Copilot started reviewing on behalf of scottaddie June 11, 2026 21:51 View session

Copilot AI reviewed Jun 11, 2026

View reviewed changes

This comment has been minimized.

Sign in to view

scottaddie marked this pull request as draft June 11, 2026 21:58

Copilot started work on behalf of scottaddie June 11, 2026 22:00 View session

Apply consistent Prerequisites sections across all SDK READMEs

d715e4c

Co-authored-by: scottaddie <10702007+scottaddie@users.noreply.github.com>

Copilot AI changed the title ~~Clarify .NET README prerequisites~~ Standardize README prerequisites across all SDK languages Jun 11, 2026

Copilot finished work on behalf of scottaddie June 11, 2026 22:05

scottaddie marked this pull request as ready for review June 11, 2026 22:06

This comment has been minimized.

Sign in to view

github-actions Bot reviewed Jun 11, 2026

View reviewed changes

Comment thread python/README.md Outdated

Copilot started work on behalf of scottaddie June 11, 2026 22:19 View session

Copilot finished work on behalf of scottaddie June 11, 2026 22:21

Copilot started work on behalf of scottaddie June 11, 2026 22:35 View session

Update Python README CLI prerequisite to match other SDKs

92fd9ac

Co-authored-by: scottaddie <10702007+scottaddie@users.noreply.github.com>

Copilot finished work on behalf of scottaddie June 11, 2026 22:38

This comment has been minimized.

Sign in to view

Copilot started work on behalf of scottaddie June 11, 2026 22:45 View session

Fix trailing period typo in Java README CLI version string

6ed8ea3

Co-authored-by: scottaddie <10702007+scottaddie@users.noreply.github.com>

Copilot finished work on behalf of scottaddie June 11, 2026 22:48

This comment has been minimized.

Sign in to view

Copilot started work on behalf of scottaddie June 11, 2026 22:55 View session

Standardize PATH formatting in Prerequisites sections across all READMEs

9bedf64

Co-authored-by: scottaddie <10702007+scottaddie@users.noreply.github.com>

Copilot finished work on behalf of scottaddie June 11, 2026 22:58

This comment has been minimized.

Sign in to view

stephentoub reviewed Jun 12, 2026

View reviewed changes

Comment thread dotnet/README.md

stephentoub approved these changes Jun 12, 2026

View reviewed changes

scottaddie commented Jun 15, 2026

View reviewed changes

Comment thread dotnet/README.md Outdated

Copilot started work on behalf of scottaddie June 15, 2026 15:00 View session

Copilot finished work on behalf of scottaddie June 15, 2026 15:21

Copilot started work on behalf of scottaddie June 15, 2026 15:21 View session

Remove .NET CLI prereq and add "To use the SDK:" lead-in text to all …

f6641f7

…SDK READMEs Co-authored-by: scottaddie <10702007+scottaddie@users.noreply.github.com>

Copilot finished work on behalf of scottaddie June 15, 2026 15:25

scottaddie commented Jun 15, 2026

View reviewed changes

Copilot started work on behalf of scottaddie June 15, 2026 15:42 View session

Update lead-in text to "To use the SDK, you'll need:" across all SDK …

903be53

…READMEs Co-authored-by: scottaddie <10702007+scottaddie@users.noreply.github.com>

Copilot finished work on behalf of scottaddie June 15, 2026 15:45

edburns approved these changes Jun 15, 2026

View reviewed changes

Merge branch 'main' into scottaddie/readme-prerequisites

717a45d

scottaddie requested a review from stephentoub June 15, 2026 17:10

stephentoub approved these changes Jun 15, 2026

View reviewed changes

Conversation

scottaddie commented Jun 11, 2026 • edited by Copilot AI Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Copilot's findings

Uh oh!

This comment has been minimized.

scottaddie commented Jun 11, 2026

Uh oh!

Copilot AI commented Jun 11, 2026

Uh oh!

This comment has been minimized.

github-actions Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

scottaddie commented Jun 11, 2026

Uh oh!

Copilot AI commented Jun 11, 2026

Uh oh!

This comment has been minimized.

scottaddie commented Jun 11, 2026

Uh oh!

Copilot AI commented Jun 11, 2026

Uh oh!

This comment has been minimized.

scottaddie commented Jun 11, 2026

Uh oh!

Copilot AI commented Jun 11, 2026

Uh oh!

This comment has been minimized.

Uh oh!

stephentoub left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

scottaddie Jun 15, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jun 15, 2026

Choose a reason for hiding this comment

Uh oh!

edburns left a comment

Choose a reason for hiding this comment

Uh oh!

stephentoub Jun 15, 2026

Choose a reason for hiding this comment

Uh oh!

stephentoub Jun 15, 2026

Choose a reason for hiding this comment

Uh oh!

stephentoub Jun 15, 2026

Choose a reason for hiding this comment

Uh oh!

stephentoub Jun 15, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Jun 15, 2026

Cross-SDK consistency review ✅

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

scottaddie commented Jun 11, 2026 •

edited by Copilot AI

Loading