Prefer partial declarations with commented-out existing APIs in api-proposal skill#125104
Merged
eiriktsarpalis merged 2 commits intodotnet:mainfrom Mar 3, 2026
Merged
Conversation
… format Address @bartonjs review feedback from dotnet#124808: prefer partial class declarations with commented-out existing members over diff blocks for API proposals. This makes it easy for the meeting chair to delete existing API context when posting final approval notes. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the api-proposal Copilot skill guidance to prefer partial type declarations where existing members are commented out (under a // EXISTING marker) instead of using diff blocks, making it easier to trim context when posting final API review notes.
Changes:
- Replaces the
diff-block recommendation in the checklist withpartial+ commented-out existing members guidance. - Removes the
diffexample from the skill and updates the// EXISTINGexample to comment out existing members (and drop// NEW).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| .github/skills/api-proposal/references/api-proposal-checklist.md | Updates the checklist item to recommend partial + commented-out existing members for context. |
| .github/skills/api-proposal/SKILL.md | Removes the diff example and documents the new “comment out existing members” pattern with an updated example. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
bartonjs
approved these changes
Mar 3, 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.
Addresses @bartonjs late review feedback from #124808.
Changes the api-proposal skill to prefer
partialclass declarations with commented-out existing members overdiffblocks when showing additions to existing types. This makes it easy for the meeting chair to delete existing API context when posting final approval notes.Changes
diffblock example; update the// EXISTING/// NEWexample to comment out existing members and drop the// NEWmarker