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. Several SDKs also incorrectly listed the GitHub Copilot CLI as a prerequisite despite bundling it.

Changes

All SDKs: Add "To use the SDK, you'll need:" lead-in sentence before the prerequisites bullet list in dotnet, nodejs, python, go, rust, and java READMEs
.NET / Node.js / Python / Rust: Remove the CLI installation bullet from Prerequisites — these SDKs bundle 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.

stephentoub

Other than the .NET issue, LGTM

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

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

edburns

LGTM for Java

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

github-actions · 2026-06-15T19:18:03Z

Cross-SDK consistency review ✅

This PR achieves strong cross-SDK documentation consistency. Here's my review:

What's consistent across all six SDKs

Property	All SDKs
Section heading	`## Prerequisites` ✓
Lead-in sentence	"To use the SDK, you'll need:" ✓
Section placement	Before Installation / Quick Start ✓
Language runtime listed	✓

CLI bundling treatment (correctly differentiated)

SDK	Bundles CLI?	CLI listed as prereq?	Correct?
.NET	Yes (downloads at build via MSBuild targets)	No	✓
Node.js	Yes (npm package)	No	✓
Python	Yes (platform wheels)	No	✓
Rust	Yes (`bundled-cli` feature, on by default)	No	✓
Go	Opt-in only (`go tool bundler`)	Yes	✓
Java	No	Yes	✓

On the open thread re: Java CLI bundling

I checked java/src/main/java/com/github/copilot/CliServerManager.java — Java defaults to "copilot" in PATH and has no download or embed mechanism. It does not bundle the CLI, unlike .NET/Node.js/Python/Rust. The PR correctly lists it as a Java prerequisite. Java also does not support the COPILOT_CLI_PATH environment variable (unlike Go), only the cliPath option in CopilotClientOptions.

One minor inconsistency worth considering

Java specifies a minimum CLI version: GitHub Copilot CLI 1.0.55-5 or later
Go does not: GitHub Copilot CLI installed and in \PATH``

Since both SDKs require the CLI installed by the user, it may be worth either adding a minimum version to the Go prerequisite or removing the version from Java for consistency. That said, this is a minor point and may be intentional if Go has broader version compatibility.

Overall, the PR is well-structured and the cross-SDK consistency is in good shape.

Generated by SDK Consistency Review Agent for issue #1636 · sonnet46 1.3M · ◷

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

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

Comment thread dotnet/README.md Outdated

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

Comment thread java/README.md

Comment thread nodejs/README.md Outdated

Comment thread python/README.md Outdated

Comment thread rust/README.md Outdated

This comment has been minimized.

Sign in to view

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

Remove bundled CLI prereq from Node.js, Python, and Rust READMEs

c4aa156

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

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

stephentoub added this pull request to the merge queue Jun 16, 2026

Merged via the queue into main with commit 8ae873d Jun 16, 2026
15 checks passed

stephentoub deleted the scottaddie/readme-prerequisites branch June 16, 2026 02:23

This was referenced Jun 18, 2026

Bump GitHub.Copilot.SDK from 1.0.1 to 1.0.2 dariuszparys/coralph#148

Open

Bump GitHub.Copilot.SDK from 1.0.1 to 1.0.2 tkopacz/fy26-githubCLISDK-demos-pub#5

Open

Bump GitHub.Copilot.SDK from 0.2.2 to 1.0.2 sikebe-demo/copilot-sdk-playground#206

Open

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.

This comment has been minimized.

Uh oh!

stephentoub left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

edburns left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment has been minimized.

github-actions Bot commented Jun 15, 2026

Cross-SDK consistency review ✅

What's consistent across all six SDKs

CLI bundling treatment (correctly differentiated)

On the open thread re: Java CLI bundling

One minor inconsistency worth considering

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

scottaddie commented Jun 11, 2026 •

edited by Copilot AI

Loading