skills.rest
recyclarr
recyclarrOFFICIAL
Explore all skills by this author →
WebsiteGitHub

changelog

Document software release changes in keepachangelog.com format for end-users.

2.1k|36|Updated Feb 4, 2021
Search Tags:#changelog#versioning#documentation#markdown#communication#release notes
One-click install
npx skills add https://github.com/recyclarr/recyclarr --skill changelog-recyclarr
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: changelog
Source: https://github.com/recyclarr/recyclarr/tree/main/.opencode/skills/changelog
Command: npx skills add https://github.com/recyclarr/recyclarr --skill changelog-recyclarr

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill standardizes the process of updating the CHANGELOG.md file, ensuring clear, consistent, and user-friendly release notes for end-users.

Core Features & Use Cases

  • Standardized Format: Adheres to the keepachangelog.com format for consistency.
  • Audience Focus: Tailors descriptions for non-technical end-users.
  • Breaking Change Handling: Provides a clear format for documenting breaking changes and upgrade guides.
  • Use Case: When preparing for a new software release, use this Skill to ensure the CHANGELOG.md accurately reflects all changes in a way that is easy for users to understand.

Quick Start

Use the changelog skill to add a new entry for a fixed bug in the unreleased section.

Frequently Asked Questions about changelog

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

FAQPage Schema
How do I format release notes for non-technical end users?▼

To format release notes for non-technical users, follow the keepachangelog.com standard to document new features, bug fixes, and breaking changes with clear descriptions. This ensures consistent formatting for upgrade guides and end-user comprehension.

What is the best way to document breaking changes in a changelog?▼

The best way to document breaking changes in a changelog is to provide clear descriptions and upgrade guides under a dedicated section following the keepachangelog.com format, ensuring end users understand the impact and required actions.

How do I add a new bug fix entry to an unreleased changelog section?▼

Add a new bug fix entry to the unreleased changelog section by applying the keepachangelog.com format, writing a clear non-technical description, and including any relevant GitHub issue references for traceability.

Does the keepachangelog.com format support linking GitHub issues in release notes?▼

Yes, the keepachangelog.com format supports linking GitHub issues in release notes. You can manage the addition of new features and bug fixes while including GitHub issue references to ensure traceability for end users.

Can I use this approach to generate upgrade guides for software releases?▼

Yes, you can use this approach to generate upgrade guides for software releases. It provides a clear format for documenting breaking changes and ensures consistent formatting for upgrade guides tailored to non-technical end-users.

Related Skills

Explore More Content & Communication Skills→
decentpastedecentpaste
232

github-release

Generate GitHub releases from conventional commit messages.

Official
Advanced
huidgehuidge
2

static-markdown-site

Convert a Markdown directory into a static website with a grouped sidebar.

Community
Intermediate
sunholo-datasunholo-data
33

AILANG Release Manager

Automates end-to-end AILANG release management including pre-release checks, version bumps, changelog updates, git tagging, CI/CD verification, and release broadcasting.

Official
Intermediate
FelipePepeFelipePepe

rule-stakeholders

Translate technical changes into business value for non-technical stakeholders.

Community
Basic