breaking-change-doc
Installation
SKILL.md
Breaking Change Documentation Skill
Generate high-quality breaking change documentation for merged dotnet/runtime pull requests and file it as an issue in dotnet/docs.
Overview
When a PR in dotnet/runtime introduces a breaking change, the docs team needs a structured issue in dotnet/docs describing the change, its impact, and migration guidance. This skill automates that process:
- Gather PR context — read the PR, its diff, related issues, comments, and reviews.
- Detect version — run the helper script to determine which .NET release the change lands in.
- Check for duplicates — search dotnet/docs for existing breaking-change issues for this PR.
- Fetch reference material — read the issue template and recent example issues from dotnet/docs.
- Author the documentation — produce the issue body following the template structure and example quality.
- Publish — write output files and optionally comment on the source PR.