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

release-notes

Generate release notes for PR changes affecting tracked paths.

1.2k|334|Updated Oct 13, 2022
Search Tags:#changelog#versioning#documentation#guidelines#pr#ci#release-notes
One-click install
npx skills add https://github.com/dotnet/dotnet --skill release-notes-dotnet
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: release-notes
Source: https://github.com/dotnet/dotnet/tree/main/src/fsharp/.github/skills/release-notes
Command: npx skills add https://github.com/dotnet/dotnet --skill release-notes-dotnet

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps teams generate consistent release notes for PR changes that affect tracked paths, ensuring accurate documentation before merging.

Core Features & Use Cases

  • Enforces a standard release notes format with sections such as Fixed, Added, Changed, and Breaking Changes.
  • Supports versioning and repository-specific fields (Version, Path, Sink Mapping) to align with project conventions.
  • Provides a clear, copy-ready entry workflow for PRs that modify tracked paths.

Quick Start

Create a release notes entry for the current PR by following the documented format and including the PR reference.

Frequently Asked Questions about release-notes

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

FAQPage Schema
How do I generate release notes for a PR?▼

To generate release notes for a PR, you create an entry following the standard format that includes the PR reference and details sections like Fixed, Added, Changed, and Breaking Changes for the modified tracked paths.

What format is required for PR release notes?▼

The required format for PR release notes includes Version, Path, Sink Mapping fields, and specific sections for Fixed, Added, Changed, and Breaking Changes to ensure consistent documentation before merging.

Why does my CI check fail when modifying tracked paths?▼

Your CI check fails because modifying tracked paths requires a corresponding release notes entry. You must add a properly formatted release notes file with a PR reference to pass the CI checks.

What sections should I include in my changelog entry?▼

Your changelog entry should include sections for Fixed, Added, Changed, and Breaking Changes, along with repository-specific fields like Version, Path, and Sink Mapping to align with project conventions.

When do I need to add a release notes entry to my pull request?▼

You need to add a release notes entry to your pull request whenever your changes touch tracked paths within the repository, ensuring accurate documentation is present before merging.

Related Skills

Explore More Software Engineering Skills→
ByronWilliamsCPAByronWilliamsCPA
1

pr-prepare

Generate Markdown pull request descriptions from git context with conventional titles.

Official
Intermediate
corv89corv89
25

release

Merge PRs, tag versions, and publish GitHub releases with changelog notes.

Community
Advanced
cursor-jscursor-js

creating-changesets

Create standardized markdown changesets for semantic versioning and release notes.

Official
Intermediate
ArogyaReddyArogyaReddy

changelog-automation

Generate changelogs from commits and PRs using Keep a Changelog and Conventional Commits.

Community
Advanced