changelog-writing
How to write and maintain a changelog humans actually read — Keep a Changelog structure, an Unreleased section, the six standard categories (Added/Changed/Deprecated/Removed/Fixed/Security), SemVer linkage, and when to hand-write vs auto-generate from conventional commits. Includes a runnable linter.
Included with Vanara Pro ($10/mo) — unlocks all 206 items. See pricing →
Overview
A changelog answers one question for a human: what changed, and do I need to do anything about it? It is not the git log, not the release notes blog post, and not the diff. It is a curated, reverse-chronological record written from the *consumer's* perspective. This skill is the deep reference for producing one that earns its place in the repo root — the structure, the editorial judgement, the aut
What it covers
- Anatomy of a good entry
- The six categories
- The Unreleased section
- [2.1.0] - 2026-06-29
- SemVer linkage
- Hand-written vs auto-generated
- Automation: Conventional Commits and Generators
- Release Workflow