framework_changelog_skill

Overview

This skill verifies that a framework's CHANGELOG.md is accurate, user-focused, and formatted for public release. It helps maintainers update or review changelogs so users can understand how changes affect them. The skill enforces Keep a Changelog style and Semantic Versioning guidance for visible API changes.

How this skill works

The skill inspects CHANGELOG.md entries against the codebase, focusing on publicly visible classes and methods under src/. It checks that entries are written from the user's perspective, reference PR/Issue links in the correct format, and classify changes (Added, Changed, Fixed) per Keep a Changelog. It also verifies version bump guidance for breaking and non-breaking changes and flags missing FQCNs when class names are referenced.

When to use it

• Before releasing a new framework version to ensure the changelog reflects user-visible changes
• During pull request review when src/ public APIs or behaviors are modified
• When backporting bug fixes to ensure patch-level entries are appropriate
• When auditing repository documentation for public consumption

Best practices

• Write changelog entries from the user's perspective, describing impact rather than implementation details
• Follow Keep a Changelog sections (Added, Changed, Fixed, Deprecated, Removed, Security)
• Link PRs and issues with markdown links like #123
• Use FQCNs for class references and prefer interface/behavior descriptions for methods
• Bump minor/major for breaking changes; allow patch for small bugfixes that alter behavior only to fix bugs

Example use cases

• A reviewer detects a public method signature change and uses the skill to confirm the changelog note and version bump are required
• A maintainer prepares a release and runs the skill to ensure all src/ public API changes are recorded under appropriate headings
• A backport of a bugfix is evaluated to decide if it can be listed as a patch-level fix in CHANGELOG.md
• A documentation audit uses the skill to enforce user-facing phrasing and correct PR/Issue link formatting