modelcontextprotocol/csharp-sdk
Watch
1
0
Fork
You've already forked csharp-sdk
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Update package READMEs as part of the release process (#1683)

Browse source 
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jeffhandley <1031940+jeffhandley@users.noreply.github.com>
This commit is contained in:
Copilot 2026-07-07 15:13:32 -04:00 • committed by GitHub
commit 1214556707
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 152 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

18
.github/skills/prepare-release/references/readme-snippets.md vendored
View file

@ -4,19 +4,21 @@ This reference describes how to validate that C# code samples in README files co
## Which READMEs to Validate
Validate code samples from the **package README** files — these are shipped with NuGet packages and are the primary documentation users see:
Validate code samples from the **package README** and the root repository README:
| README | Package |
|--------|---------|
| `README.md` (root) | ModelContextProtocol |
| `src/ModelContextProtocol.Core/README.md` | ModelContextProtocol.Core |
| `src/ModelContextProtocol.AspNetCore/README.md` | ModelContextProtocol.AspNetCore |
| README | Notes |
|--------|-------|
| `src/PACKAGE.md` | The single shared embedded README packed into every SDK package. This is the primary documentation users see on nuget.org. |
| `README.md` (root) | The GitHub repository readme. Not packed into packages, but visible to developers browsing the repo. |
Sample README files (`samples/*/README.md`) are excluded — the samples themselves are buildable projects and are validated by CI.
All SDK packages embed `src/PACKAGE.md` via their `.csproj` files. There are no per-package
README files; paths such as `src/ModelContextProtocol.Core/README.md` do not exist.
Sample README files (`samples/*/README.md`) are excluded -- the samples themselves are buildable projects and are validated by CI.
## What to Extract
Extract only fenced code blocks tagged as `csharp` (` ```csharp `). Skip blocks tagged as plain ` ``` ` (shell commands, install instructions) or any other language.
Extract only fenced code blocks tagged as `csharp` (` ```csharp `) from `src/PACKAGE.md` and `README.md`. Skip blocks tagged as plain ` ``` ` (shell commands, install instructions) or any other language.
### Handling Incomplete Snippets