CtrlK
BlogDocsLog inGet started
Tessl Logo

breaking-change-doc

Generate breaking change documentation for merged dotnet/runtime PRs. USE FOR: creating breaking change docs, "document this breaking change", "write breaking change issue for PR #NNNNN", processing PRs labeled needs-breaking-change-doc-created. DO NOT USE FOR: general code review (use code-review skill), bug fixes, API proposals (use api-proposal skill).

72

Quality

88%

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

SKILL.md
Quality
Evals
Security

Quality

Content

81%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 body is a highly actionable, well-sequenced workflow: concrete commands, exact paths, explicit validation checkpoints, and confirmation gates before any outward-facing publish action. Its main weakness is token efficiency — Step 2 in particular duplicates caveats and documents script internals/JSON fields inline that could be trimmed or moved to a reference file next to the script.

Suggestions

Deduplicate the backport-verification guidance: state the "Backports entries are candidates, not confirmed backports" caveat once and reference it from the Tentative check in Step 2, removing the near-identical paragraphs at lines 145-150 and 158-162.

Move the Step 2 script-internals explanation (release-branch cadence, tag-refinement logic, and the JSON field list) into a reference file beside Get-VersionInfo.ps1, keeping only the command, the Error/Tentative handling rules, and links to the field meanings in SKILL.md.

Drop the Troubleshooting row "Version detection script fails" down to just the gh api command, since the milestone-rollover rules it repeats are already covered in Step 2's fallback guidance.

DimensionReasoningScore

Conciseness

The steps are dense with legitimate domain-specific knowledge (branch cadence, Tentative/FallbackVersion semantics), but Step 2 is over-explained: the backport-verification caveat is stated twice (lines 145-150 and 158-162), the JSON field list and cadence logic restate what the script output itself shows, and the Troubleshooting row re-explains the manual fallback already given in Step 2. Mostly efficient with tighten-able, duplicated explanation matches anchor 3 rather than 4.

3 / 5

Actionability

Guidance is fully executable: exact pwsh invocations with parameter lists and example values, gh api commands with the raw-content accept header, concrete output paths (artifacts/docs/breakingChanges/issue-draft.md), a complete area-label to feature-area mapping table, and an explicit title format. Copy-paste ready with the common cases covered matches anchor 5.

5 / 5

Workflow Clarity

Steps 0-6 are clearly sequenced with explicit validation checkpoints: duplicate-issue check (Step 3), an error-to-manual-fallback loop (Step 2), a tentative-to-verify-backport-to-FallbackVersion procedure, draft-only mode requiring user confirmation before publishing, and confirmation gates in multi-PR batch mode. Validation and feedback loops are present, so the destructive/batch cap does not apply; this matches anchor 5 rather than 4 because error recovery is explicit, not implicit.

5 / 5

Progressive Disclosure

Helper-script logic is appropriately externalized into Get-VersionInfo.ps1 and Build-IssueComment.ps1, with a Files table signaling each path and purpose, and the body is well structured with headers and tables. However, the roughly 60-line Step 2 version-detection exposition (script internals, cadence rules, and JSON field documentation) would sit better in a reference file, leaving SKILL.md a leaner overview — a minor organization gap matching anchor 4 rather than 5.

4 / 5

Total

17

/

20

Passed

Description

95%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 strong: it states a concrete capability, provides explicit USE FOR trigger phrases users would naturally say (including the automation label), and delineates scope with DO NOT USE FOR redirects to sibling skills. The only minor gap is that it names just the headline action rather than the fuller pipeline (issue filing in dotnet/docs, version detection, PR commenting).

DimensionReasoningScore

Specificity

"Generate breaking change documentation for merged dotnet/runtime PRs" names the domain and concrete action, but the description covers only the headline action — it omits issue creation in dotnet/docs, version detection, and PR commenting. Several specific actions with minor gaps matches anchor 4, not the comprehensive coverage of anchor 5.

4 / 5

Completeness

Explicitly answers both "what" ("Generate breaking change documentation for merged dotnet/runtime PRs") and "when" ("USE FOR:" with quoted trigger phrases), and adds negative scope ("DO NOT USE FOR: general code review..."). This is a clear anchor-5 match rather than 4 because the when-clause is explicit and concrete.

5 / 5

Trigger Term Quality

"creating breaking change docs", "document this breaking change", "write breaking change issue for PR #NNNNN", and "processing PRs labeled needs-breaking-change-doc-created" cover multiple natural user phrasings across verb variations plus the automation label. Coverage is comprehensive with no meaningful natural terms missing, matching anchor 5.

5 / 5

Distinctiveness Conflict Risk

The trigger is a narrow niche (dotnet/runtime breaking-change docs, a specific PR label) and the description explicitly redirects overlapping requests to the code-review and api-proposal skills, minimizing conflict risk. Clear niche with distinct triggers matches anchor 5.

5 / 5

Total

19

/

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.

Validation — 16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository
dotnet/runtime
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.