changelog

Update CHANGELOG.md with categorized user-facing release notes.

25|1|Updated Apr 23, 2026
One-click install
npx skills add https://github.com/ShiroiKuma0/shiroikumanojisho --skill changelog-shiroikuma0
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: changelog
Source: https://github.com/ShiroiKuma0/shiroikumanojisho/tree/main/.claude/skills/changelog
Command: npx skills add https://github.com/ShiroiKuma0/shiroikumanojisho --skill changelog-shiroikuma0

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Manage user-facing release notes by updating CHANGELOG.md to reflect new changes.

Core Features & Use Cases

  • Clarifies what counts as user-facing changes and where they must be recorded in CHANGELOG.md.
  • Provides a standardized format for release notes, with sections like Added, Fixed, and Notes, to keep releases consistent.
  • Supports syncing notes with GitHub release notes at publish time to ensure traceability.

Quick Start

Add an Unreleased entry to CHANGELOG.md describing the user-facing change using the standard template.

Frequently Asked Questions about changelog

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

FAQPage Schema
How do I maintain an Unreleased section in CHANGELOG.md for new features?

You maintain an Unreleased section in CHANGELOG.md by adding new entries describing user-facing changes under standard category headers like Added, Fixed, and Notes before moving them to a versioned release section.

What's the best way to sync release notes with GitHub releases during a publish?

The best way to sync release notes with GitHub releases is to copy the finalized version block from CHANGELOG.md into the GitHub release notes at publish time, ensuring traceability between the repository file and the platform release.

How do I format keep-a-changelog entries for software releases and bug fixes?

Format keep-a-changelog entries by grouping user-facing changes under standardized category headers like Added, Fixed, and Notes, ensuring consistent release notes across software releases and bug fixes.

Does this release-notes process work for documenting non-user-facing changes?

No, this release-notes process is specifically designed to clarify and document user-facing changes. Internal refactoring or technical debt that does not impact users should not be recorded in this CHANGELOG.md workflow.

When do I need to update CHANGELOG.md during the release process?

Update CHANGELOG.md during the release process whenever a new user-facing change occurs, such as feature rollouts or bug fixes, by placing the entry in the Unreleased section until the version is officially published.