Name: mitigate-breaking-changes
Rating: 58.4 (1 reviews)
Author: Azure

mitigate-breaking-changes

Patterns and techniques for mitigating breaking changes during Azure management-plane SDK migration from Swagger/AutoRest to TypeSpec. Covers SDK-side customizations (partial classes, CodeGenType, CodeGenSuppress) and TypeSpec decorator customizations (clientName, access, markAsPageable, alternateType, hierarchyBuilding).

Quality

66%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

Securityby

Passed

No findings from the security scan

Fix and improve this skill with Tessl

tessl review fix ./.github/skills/mitigate-breaking-changes/SKILL.md

Quality

Content

65%

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

The body is highly actionable with executable, specific code and clear guardrails across SDK-side and TypeSpec customizations. Weaker on workflow validation checkpoints and on splitting monolithic content into references.

Suggestions

Add explicit validation checkpoints to the regeneration/baseline workflows (e.g., 'Regenerate, run ApiCompat, only baseline remaining WirePathAttribute diffs after confirming no other diffs').

Extract the extended @@hierarchyBuilding legacy-only material and the extension-resources detail into reference files (e.g., references/hierarchy-building.md, references/extension-resources.md) and link them one level deep, consolidating the repeated using/#suppress requirements once.

Add a real link or path for the referenced 'mpg-migration' skill so the cross-reference is navigable.

Dimension	Reasoning	Score
Conciseness	Mostly lean with no basic-concept padding and tight code blocks, but repeats the using/#suppress requirements across multiple decorators and the @@hierarchyBuilding legacy treatment is lengthy.	2 / 3
Actionability	Provides copy-paste-ready C# and TypeSpec snippets, exact tspconfig.yaml keys, concrete file paths, compile-error codes, and explicit WRONG vs CORRECT contrasts.	3 / 3
Workflow Clarity	Sequences and Requirements lists are present with detect/fix/regenerate ordering, but validation checkpoints are implicit and the destructive regen+baseline path lacks explicit validate-then-proceed feedback loops.	2 / 3
Progressive Disclosure	Well-organized into clear sections but monolithic—all detail is inline with no bundle files, and the referenced 'mpg-migration' skill is mentioned by name without a link.	2 / 3
	Total	9 / 12 Passed

Description

67%

Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.

The description is specific and distinctive, clearly scoping a niche migration domain with concrete customization techniques. Its main weakness is the missing explicit 'Use when' trigger guidance and reliance on technical jargon over natural phrasings.

Suggestions

Add an explicit 'Use when...' clause with natural trigger phrases (e.g., 'Use when migrating Azure management-plane .NET SDKs from Swagger/AutoRest to TypeSpec and preserving backward compatibility').

Soften trigger terms with conversational variations users would actually say (e.g., 'keep backward compatibility', 'suppress breaking changes') alongside the technical decorator names.

Dimension	Reasoning	Score
Specificity	Lists multiple concrete techniques—'partial classes, CodeGenType, CodeGenSuppress' and decorators 'clientName, access, markAsPageable, alternateType, hierarchyBuilding'—matching the anchor for multiple specific concrete actions.	3 / 3
Completeness	Clearly states what it does, but lacks an explicit 'Use when...' trigger clause, so when-to-use is only implied—capped at 2 per guidelines.	2 / 3
Trigger Term Quality	'mitigate breaking changes' is natural, but the bulk of triggers are technical decorator names ('CodeGenType', 'markAsPageable', 'hierarchyBuilding') with missing common conversational variations.	2 / 3
Distinctiveness Conflict Risk	The niche is sharply defined—Azure management-plane SDK migration Swagger/AutoRest to TypeSpec—with distinct triggers unlikely to conflict with other skills.	3 / 3
	Total	10 / 12 Passed

Validation

100%

Warnings & errors only

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation — 16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository: Azure/azure-sdk-for-net
Path: .github/skills/mitigate-breaking-changes/SKILL.md
Commit: 0afb185

Reviewed: 2 days ago

Table of Contents

Discovery Implementation Validation

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.