Skip to content
Skillsify
Back to registry
Documentationv1.0.0437 installs

api-changelog-writer

Writes an accurate API changelog entry from a diff. Use when the user asks to document a release, write release notes, or explain what changed in an API between versions.

SchemaLintTrigger

Install

npx skillsify add api-changelog-writer

Changelogs written from commit subjects describe what the author meant to do, not what callers now experience. This skill reads the diff itself, classifies every user-visible change, writes a one-sentence migration for each breaking change, and derives the semver bump from the highest-severity class present. It refuses to pad: if a diff contains nothing user-visible, it says so.

Quality report

Should trigger

  • Write release notes for this diff
  • What changed in the API since v2.3?
  • Draft a changelog entry for the next release

Should not trigger

  • Fix this failing test
  • Design a database schema

Files

SKILL.md
---
name: api-changelog-writer
description: Writes an accurate API changelog entry from a diff. Use when the user asks to document a release, write release notes, or explain what changed in an API between versions.
---

# API changelog writer

## When to use this
A release needs notes, or the user asks what changed in an API between versions.

## Procedure
1. Read the actual diff. Never write a changelog from commit subjects alone —
   they describe intent, not effect.
2. Classify every change as **Breaking**, **Added**, **Changed**, **Deprecated**,
   **Removed**, or **Fixed**.
3. For each breaking change, write the migration in one sentence: what the caller
   must change, from what to what.
4. Derive the semver bump from the highest-severity class present, using the
   rules in [references/semver-rules.md](references/semver-rules.md).
5. Order the entry with breaking changes first.

## Rules
- Write for the caller, not the implementer. "Refactored the auth module" is not
  a changelog entry; "`login()` now returns `null` instead of throwing on bad
  credentials" is.
- Never invent a change that is not in the diff.
- If the diff contains no user-visible change, say so rather than padding.
references/semver-rules.md
# Deriving the version bump

| Change present | Bump |
| --- | --- |
| Any breaking change | major |
| New capability, fully backward compatible | minor |
| Fix only, no interface change | patch |

A deprecation on its own is a **minor** bump. Removing something previously
deprecated is **major** — deprecation is a warning, not a grace period that
converts a removal into a minor change.

Related skills

DocumentationVerified

doc-coauthoring

Guide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.

0 installs · v1.0.0

PerformanceVerified

core-web-vitals-audit

Audits a web application for Core Web Vitals regressions. Use when the user asks to check LCP, INP or CLS, investigate a Lighthouse score drop, or review front-end performance before a release.

1,284 installs · v1.2.0

TestingVerified

flaky-test-hunter

Finds and diagnoses flaky tests in a test suite. Use when tests pass locally but fail in CI, when a suite fails intermittently, or when the user asks to stabilise or de-flake their tests.

963 installs · v1.1.0