Add an api-proposal Copilot skill#124808
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Add an api-proposal skill
There was a problem hiding this comment.
Pull request overview
This PR adds a new Copilot skill called api-proposal that automates the process of creating prototype-backed API proposals for dotnet/runtime. The skill guides users through a 6-phase pipeline from initial idea to published proposal, with emphasis on empirical validation through working prototypes.
Changes:
- Adds a comprehensive skill definition with detailed workflow phases (gather input, research, prototype, review, draft, publish)
- Provides quality checklist covering all aspects of API proposal validation
- Includes curated examples of successful API proposals with annotated lessons
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
.github/skills/api-proposal/SKILL.md |
Main skill definition with 6-phase pipeline (311 lines), including detailed instructions for prototyping, validation, and proposal drafting |
.github/skills/api-proposal/references/api-proposal-checklist.md |
Quality validation checklist organized by section (Background/Motivation, API Surface, Scope, Prototype, etc.) |
.github/skills/api-proposal/references/proposal-examples.md |
Curated examples from 6 successful proposals (#43957, #75070, #782, #60393, #1541, #36391, #74385) with annotated lessons |
Remove duplicated build/test steps from Phase 2 Prototype Validation and reference the existing workflow in copilot-instructions.md instead. Keep only api-proposal-specific steps (TFM compatibility, ref source generation). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
974ca7a to
b13dea4
Compare
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
I worry about the skill opening a PR since, even if just to close it, since that is directly counter to our current guidelines on how to do API proposals (where we say no PR should be opened until its been reviewed/approved). Can we get it to do everything and link to the branch with the prototype instead? |
Summary
Adds an
api-proposalCopilot skill that automates the prototyping and drafting of API proposals for dotnet/runtime.Motivation
Evaluating the feasibility of a feature request is frequently the biggest bottleneck when processing API proposals. Before an API can be confidently brought to review, someone needs to:
This experimentation work is time-consuming and often deters contributors from turning good ideas into actionable proposals. The goal of this skill is to automate aspects of that original experimentation, so that maintainers can confidently bring API proposals in for review.
What the skill does
The skill guides Copilot through a 6-phase pipeline:
copilot-instructions.md)Example invocations
Example of the skill in action
See #124806 for an end-to-end example of this skill producing a working prototype and proposal.
Files added
.github/skills/api-proposal/SKILL.md— Main skill definition (phases, validation steps, proposal structure).github/skills/api-proposal/references/api-proposal-checklist.md— Quality checklist for validating proposals before publishing.github/skills/api-proposal/references/proposal-examples.md— Curated examples of successful API proposals with annotated lessons