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

breaking-change

Files NuGet breaking-change documentation issues and drafts notification emails for labeled changes.

1.2k|337|Updated Oct 13, 2022
Search Tags:#SDK#NuGet#Documentation#breaking-change#gitHub issues#DotNet#notification email
One-click install
npx skills add https://github.com/dotnet/dotnet --skill breaking-change
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: breaking-change
Source: https://github.com/dotnet/dotnet/tree/main/src/nuget-client/.agents/skills/breaking-change
Command: npx skills add https://github.com/dotnet/dotnet --skill breaking-change

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

After a NuGet breaking change ships, engineers must complete tedious documentation paperwork across multiple repositories and notify the .NET Breaking Change Notifications alias, a process that is easy to miss or do incorrectly.

Core Features & Use Cases

  • Documentation Verification: Confirms the NuGet reference-docs page (NUxxxx) is merged in NuGet/docs.microsoft.com-nuget and live on learn.microsoft.com, not just tracked by an open issue.
  • dotnet/docs Issue Authoring: Drafts the official .NET breaking-change issue using the current dotnet/docs template, including version, previous/new behavior, and recommended action.
  • Notification Email Drafting: Produces an HTML-formatted email to [email protected] with what changed, who's affected, opt-out, and references.
  • Use Case: A NuGet/Home issue gets the Breaking-Change label after PR #7487 merges; invoke this skill to verify the NU5052 docs page is live, draft the dotnet/docs issue, and prepare the notification email for review.

Quick Start

Run the breaking change process for the NuGet issue that just got the Breaking-Change label and draft the docs issue and notification email.

Frequently Asked Questions about breaking-change

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

FAQPage Schema
How do I file a .NET breaking change issue for a NuGet change?▼

File an issue in dotnet/docs using the ".NET breaking change" template, including version, previous and new behavior, reason, and recommended action. Search dotnet/docs first for an existing breaking-change issue to avoid duplicates, and default to presenting a draft before filing.

How do I verify NuGet NUxxxx reference documentation is complete?▼

Check that the docs PR in NuGet/docs.microsoft.com-nuget is merged and the learn.microsoft.com errors-and-warnings page for the NUxxxx diagnostic returns live content, not a 404. An open or even closed NuGet/Home Type:Docs tracking issue alone is not proof of completion.

Where do I send the NuGet breaking change notification email?▼

Send it to [email protected], not the generic [email protected] address shown in the dotnet/docs template. The email should be HTML-formatted with the diagnostic id, affected users, opt-out, and reference links.

When should this breaking change process be triggered?▼

Trigger it after a NuGet breaking change is implemented and its NuGet/Home issue or implementing NuGet.Client PR receives the Breaking-Change label. It handles documentation and notification only, not product code changes.

Does the skill create issues and send emails automatically?▼

No, it defaults to draft mode, presenting issue bodies and the email for user review. It only files issues or creates drafts on explicit request, and the user always sends the notification email.

Related Skills

Explore More Software Engineering Skills→
dotnetdotnet
18.2k

breaking-change-doc

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

Official
Advanced
agwacomagwacom

document-release

Automates post-ship documentation updates by syncing files and polishing the changelog.

Official
Advanced
AgentientAgentient
2

authentication-session-security

Implements credential-free sign-in for select Google services via trusted intermediaries.

Official
Basic
Impertio-StudioImpertio-Studio

postgres-impl-advisory-locks

Manages session-level and transaction-level PostgreSQL advisory locks for job coordination.

Official
Intermediate