Add README code sample validation step to release-notes skill#1371
Merged
stephentoub merged 2 commits intomodelcontextprotocol:mainfrom Feb 24, 2026
Merged
Conversation
Add Step 4 to validate that C# code samples in package README files compile against the current SDK. Includes a reference document with the test project approach, snippet extraction rules, and failure classification guidance. Steps 5-10 renumbered accordingly. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
stephentoub
previously approved these changes
Feb 24, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a new validation step (Step 4) to the release-notes skill that verifies C# code samples in package README files compile against the current SDK before releasing. The change ensures documentation accuracy by creating a temporary test project that wraps README snippets with fixups for incomplete code (like ... placeholders), building them, and reporting any API mismatches as documentation bugs.
Changes:
- Added comprehensive reference document describing README code sample validation procedure
- Inserted new Step 4 into the release workflow to validate README snippets
- Renumbered all subsequent steps (5-10) to accommodate the new validation step
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
.github/skills/release-notes/references/readme-snippets.md |
New reference document providing detailed instructions for extracting, wrapping, and validating C# code snippets from package READMEs |
.github/skills/release-notes/SKILL.md |
Added Step 4 for README validation and renumbered subsequent steps from 5-10 |
jeffhandley
commented
Feb 24, 2026
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
stephentoub
approved these changes
Feb 24, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add Step 4 to validate that C# code samples in package README files compile against the current SDK. Includes a reference document with the test project approach, snippet extraction rules, and failure classification guidance. Steps 5-10 renumbered accordingly.