skills.rest
dotnet
dotnetOFFICIAL
Explore all skills by this author →
Website𝕏@dotnetfdnGitHub

breaking-change-doc

Generate breaking change documentation issues for merged dotnet/runtime pull requests.

18.2k|5.6k|Updated Sep 24, 2019
Search Tags:#Documentation#gitHub#issue generation#powerShell#breaking change#release versioning#DotNet
One-click install
npx skills add https://github.com/dotnet/runtime --skill breaking-change-doc
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: breaking-change-doc
Source: https://github.com/dotnet/runtime/tree/main/.github/skills/breaking-change-doc
Command: npx skills add https://github.com/dotnet/runtime --skill breaking-change-doc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

When a merged dotnet/runtime PR introduces a breaking change, the docs team needs a structured issue in dotnet/docs describing the change, its impact, and migration guidance. Writing these issues manually requires gathering PR context, determining the correct .NET release version, checking for duplicates, and following a strict issue template.

Core Features & Use Cases

  • Automated PR context gathering: Reads PR metadata, diffs, comments, reviews, and closing issues from dotnet/runtime to understand the change.
  • Release version detection: Runs a PowerShell helper that inspects release branches, tags, and backport PRs via the GitHub CLI to determine which .NET preview, RC, or GA release the change ships in.
  • Duplicate checking and template compliance: Searches dotnet/docs for existing breaking-change issues and authors new ones following the official issue template with before/after code examples and migration guidance.
  • Use Case: A PR labeled needs-breaking-change-doc-created is merged; the skill drafts the full issue body, builds a PR comment with a pre-filled issue-creation link, and posts it for the docs team.

Quick Start

Ask the assistant to document the breaking change in dotnet/runtime PR 114929 and review the generated draft before publishing.

Frequently Asked Questions about breaking-change-doc

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I document a breaking change for a dotnet/runtime PR?▼

Provide the merged PR number or URL and the skill gathers the PR context, detects the target .NET version, checks dotnet/docs for duplicates, and drafts a complete breaking change issue following the official template. You review the draft before it is published.

How does the skill determine which .NET version a breaking change ships in?▼

A PowerShell script inspects release branches and tags via the GitHub CLI. Once a milestone branch exists, changes merged to main ship in the next milestone, following the cadence of 7 previews, 2 RCs, then GA, with backport PRs and tag containment refining the estimate.

Can it detect backports of a breaking change to earlier releases?▼

Yes, it finds potential backport PRs through the primary PR's cross-reference graph and reports the version as tentative when a linked PR targets a release branch. You should confirm the candidate is a genuine backport by reviewing its title, description, and diff.

What happens if a breaking change issue already exists in dotnet/docs?▼

The skill searches dotnet/docs for existing issues matching the PR number with the breaking-change label. If a match is found, it reports the existing issue URL and stops rather than creating a duplicate.

What are the limitations of the version detection script?▼

Detection relies on release branch naming conventions and the GitHub CLI, so it can fail if branches are unavailable or the gh CLI errors. In that case the skill falls back to manually inspecting release branches to estimate the next milestone.

Related Skills

Explore More Software Engineering Skills→
mczkzkmczkzk

pr-template

Generates GitHub pull-request titles, descriptions, and label recommendations from a diff and plan.md file.

Community
Advanced
taizen-aitaizen-ai
8

content-reviewer

Review content for quality, clarity, and brand alignment before publishing.

Official
Advanced
NewEarthAINewEarthAI

receiving-code-review

Automate responses to code review feedback with behavioral and anti-sycophancy checks.

Community
Intermediate
medusajsmedusajs
36.1k

writing-releases

Generates GitHub release notes for Medusa releases from commit and PR metadata.

Official
Intermediate