CtrlK
BlogDocsLog inGet started
Tessl Logo

mitigate-breaking-changes

Patterns and techniques for mitigating breaking changes in Azure management-plane SDKs. Covers SDK-side customizations (partial classes, CodeGenType, CodeGenSuppress) and TypeSpec decorator customizations (clientName, access, markAsPageable, alternateType, hierarchyBuilding).

63

Quality

74%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

SecuritybySnyk

The risk profile of this skill

Fix and improve this skill with Tessl

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

Quality

Content

78%Weight 40%Scale 1-5

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

The content is highly actionable with concrete executable examples and clear sequenced guidance including safety checkpoints, but it is a monolithic single-file document that would benefit from splitting detailed reference material into bundle files.

Suggestions

Move the extended hierarchyBuilding legacy examples and the common-target-base-type table into a reference file (e.g., references/hierarchy-building.md) and link to it from SKILL.md to improve progressive disclosure.

Add an explicit validation feedback loop (e.g., run ApiCompat, review errors, fix, re-run) as a numbered workflow for the regeneration steps.

DimensionReasoningScore

Conciseness

The body is dense and code-heavy with minimal concept re-explanation; a few rationale blocks (e.g., why markAsPageable is preferred) could be trimmed slightly but most tokens earn their place.

4 / 5

Actionability

Provides copy-paste-ready C# and TypeSpec examples plus a concrete tspconfig.yaml snippet covering the common cases (partial classes, CodeGenType, markAsPageable, alternateType, hierarchyBuilding, WirePathAttribute).

5 / 5

Workflow Clarity

Numbered requirements and clear sequences with checkpoints (e.g., 'Do NOT use if already marked with @list', regenerate after adding decorators, ApiCompat detection) are present, though explicit validate->fix->retry feedback loops are only implied.

4 / 5

Progressive Disclosure

Well-organized with clear section headers, but at ~180 lines all content is inlined in SKILL.md with no bundle files or one-level-deep references to split out the lengthy hierarchyBuilding and legacy-example material.

3 / 5

Total

16

/

20

Passed

Description

70%Weight 40%Scale 1-5

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 clearly distinctive, naming concrete SDK-side and TypeSpec customization techniques, but it lacks an explicit 'Use when...' trigger clause, which limits its completeness score.

Suggestions

Add an explicit 'Use when...' clause with concrete trigger phrases (e.g., 'Use when regenerating Azure management-plane .NET SDKs and preserving backward compatibility').

Include a few natural-language synonyms users might say beyond the technical decorator names, such as 'backward compat' or 'ApiCompat errors'.

DimensionReasoningScore

Specificity

Names the domain and lists several concrete techniques (partial classes, CodeGenType, CodeGenSuppress, clientName, access, markAsPageable, alternateType, hierarchyBuilding), with only minor gaps in coverage.

4 / 5

Completeness

Has a clear 'what' (patterns for mitigating breaking changes across SDK-side and TypeSpec customizations) but no explicit 'Use when...' clause, which caps completeness at 3 per the guidelines.

3 / 5

Trigger Term Quality

Includes the natural phrase 'mitigating breaking changes' alongside domain-specific technical trigger terms (CodeGenType, markAsPageable, hierarchyBuilding) that practitioners would actually say; a few natural synonyms are missing.

4 / 5

Distinctiveness Conflict Risk

Targets a narrow, well-defined niche (Azure management-plane .NET SDK breaking-change mitigation) with distinct triggers and minimal overlap risk with other skills.

5 / 5

Total

16

/

20

Passed

Validation

100%

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

Validation16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository
Azure/azure-sdk-for-net
Reviewed

Table of Contents

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.