Replace .github/prompts with .github/skills for API review#66395
Open
Replace .github/prompts with .github/skills for API review#66395
Conversation
Convert the existing ApiReview.prompt.md into a Copilot skill that guides agents through filling out API review issues following the ASP.NET Core team's process and template. The skill is knowledge-driven (no scripts) with: - SKILL.md: Core workflow, anti-patterns, output contract - references/section-guidelines.md: Per-section guidance with examples - assets/issue-template.md: Issue body template Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The api-review prompt has been superseded by the .github/skills/api-review/ skill which provides richer structure with a SKILL.md, section guidelines, issue template, and reference materials. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
github-actions
Bot
added
the
needs-area-label
Contributor
There was a problem hiding this comment.
Pull request overview
This PR transitions API review issue-authoring guidance from the legacy .github/prompts/ApiReview.prompt.md prompt file to a structured .github/skills/api-review/ skill, including a reusable issue body template and per-section guidance.
Changes:
- Added an
api-reviewskill (SKILL.md) with a defined workflow, prerequisites, quality checklist, and anti-patterns. - Added reference documentation for per-section guidance (
references/section-guidelines.md) and an API proposal issue body template (assets/issue-template.md). - Removed the legacy
.github/prompts/ApiReview.prompt.mdfile.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| .github/skills/api-review/SKILL.md | Adds the main skill definition, workflow, quality checklist, and references. |
| .github/skills/api-review/references/section-guidelines.md | Adds detailed guidance and examples for each API proposal section. |
| .github/skills/api-review/assets/issue-template.md | Adds a reusable API proposal issue body template aligned with the repo’s API proposal structure. |
| .github/prompts/ApiReview.prompt.md | Deletes the legacy prompt-based instructions. |
Comment on lines
+1
to
+9
| --- | ||
| name: api-review | ||
| description: > | ||
| Fill out API review issues for ASP.NET Core following the team's process and template. | ||
| USE FOR: writing API review issues, preparing api-ready-for-review proposals, filling | ||
| API proposal templates, creating API review descriptions from issues and commits, | ||
| "fill out the API review", "prepare API review". | ||
| DO NOT USE FOR: reviewing API design decisions, approving APIs, general code review. | ||
| --- |
There was a problem hiding this comment.
PR description says the api-review skill already exists and that no other changes are needed, but this PR is adding the entire .github/skills/api-review/ content (SKILL + references + assets). Please update the PR description to reflect the additional new files, or split the change into separate PRs to avoid confusion during review/history.
Adds a workflow that automatically detects new public APIs in merged PRs by analyzing PublicAPI.Unshipped.txt changes, checks for existing API review issues, and creates api-suggestion issues for uncovered APIs. The workflow: - Triggers on merged PRs that change PublicAPI.Unshipped.txt files - Extracts net-new API additions (filtering out signature updates) - Searches existing api-suggestion/api-ready-for-review/api-approved issues - Creates grouped API review issues with the standard template - Adds appropriate area labels based on file paths - Posts a summary comment on the triggering PR Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
github-actions
Bot
added
area-infrastructure
Contributor
|
Hey @dotnet/aspnet-build, looks like this PR is something you want to take a look at. |
Instead of duplicating the issue template and section guidelines inline, the workflow now instructs the agent to read the skill files at runtime: - .github/skills/api-review/assets/issue-template.md - .github/skills/api-review/references/section-guidelines.md - .github/skills/api-review/SKILL.md This keeps the template in a single source of truth and ensures the workflow stays in sync with skill updates. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Add a pre-activation step that checks github.event.pull_request.merged and exits early (exit 1) for PRs that were closed without merging. The workflow agent only runs when merged_check_result == 'success'. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
wtgodbe
approved these changes
Apr 20, 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.
Summary
Removes the old
.github/prompts/ApiReview.prompt.mdfile which has been superseded by the.github/skills/api-review/skill.The skill provides a richer structure with:
SKILL.mdwith structured frontmatter and workflowreferences/section-guidelines.mdwith detailed per-section guidanceassets/issue-template.mdmatching the repo's API proposal templateChanges
.github/prompts/ApiReview.prompt.md