skills.rest
Arasz
AraszCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

whats-new-update

Updates the README What's new section with compact release entries.

2|Updated Aug 2, 2026
Search Tags:#changelog#documentation#markdown#readme#release notes#nuget#whats new
One-click install
npx skills add https://github.com/Arasz/ai-raccoon --skill whats-new-update-arasz
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: whats-new-update
Source: https://github.com/Arasz/ai-raccoon/tree/main/.ai-badger/skills/learned/software-development/whats-new-update
Command: npx skills add https://github.com/Arasz/ai-raccoon --skill whats-new-update-arasz

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Keeping a README's "What's new" section consistent after each release is easy to get wrong: entries become verbose, internal refactors get listed, and formatting drifts. This Skill enforces a compact, braggable-features-only format for release highlights that also render on nuget.org via the packed readme. ## Core Features & Use Cases - Entry filtering rules: Only user-facing features worth bragging about qualify; internal refactors, bug fixes, and dependency bumps are excluded. - Strict entry shape: Each entry is a bold title plus a doc or ADR reference link, with the version number included only when the entry shipped under it. - Ordering and linking conventions: Newest entries go at the top, ADRs are linked when they exist, and patch releases without braggable features get no entry. - Use Case: After shipping release 1.42.0 of a .NET tool, add a single bold-titled bullet linking to the relevant ADR instead of writing a prose changelog paragraph. ## Quick Start Update the README What's new section for the latest release following the compact entry rules.

Frequently Asked Questions about whats-new-update

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

FAQPage Schema
How do I write a What's new entry for a README release section?▼

Write each entry as a bold title followed by a doc or ADR reference link, with no prose or justification. Include the version number in the bold title only when the entry shipped under that version, and place the newest entry at the top.

What changes belong in a README What's new section?▼

Only user-facing features worth bragging about belong: new capabilities, big speed wins, or workflows that stopped being painful. Internal refactors, bug fixes, and dependency bumps are excluded.

Should a patch release get a What's new entry?▼

A patch release with no braggable feature gets no entry. The section is reserved for changes the user can genuinely feel, not routine maintenance releases.

What should a What's new entry link to?▼

Link an ADR when one exists for the change; otherwise link a plan, how-to, or reference document. The link is the only supporting material allowed alongside the bold title.

Why keep the What's new section compact for NuGet packages?▼

The README is packed into the NuGet package readme, so the section renders on nuget.org. Compact bold-title entries keep the package page scannable without prose or justification.

Related Skills

Explore More Software Engineering Skills→
andreaswasitaandreaswasita
33

refining-iteratively

Generate targeted follow-up prompts for iterative draft refinement.

Community
Intermediate
rudironsonirudironsoni

dotnet-gha-publish

Automate .NET artifact publishing in GitHub Actions workflows.

Community
Advanced
Benmore-StudioBenmore-Studio
1

release-notes

Summarize technical tickets, PRDs, and changelogs into structured release notes.

Official
Intermediate
sgcarstrendssgcarstrends
21

changelog

Generate CHANGELOG.md from conventional commits using semantic-release.

Official
Advanced