Changelog Entry Writer

Write clear, useful design system changelog entries that help consumers understand what changed and what to do about it.

All Prompts

When to Use

  • Before publishing a new design system release
  • When preparing release notes for consumers
  • To standardize changelog format across your team
  • When summarizing a batch of PRs into user-facing notes

The Prompt

Write a design system changelog entry for version [VERSION].

Changes to document:
[list your changes, PRs, or commits here]

Format rules:
1. Group by: Added, Changed, Fixed, Deprecated, Removed, Security
2. Each item should state: what changed, why, and what the consumer needs to do (if anything)
3. For breaking changes: prefix with "BREAKING:" and include migration steps
4. Link to relevant docs or migration guides where helpful
5. Use plain language. Avoid internal jargon.
6. Add component/token name in backticks for easy scanning

Tone: Concise and helpful. Assume the reader is a developer using the design system in their product.

Example Output

# v3.2.0 — March 26, 2026

## Added
- **`Drawer` component** — A slide-in panel for secondary content. Supports left/right placement, multiple sizes, and focus trapping. [Docs](/components/drawer)
- **`color.background.overlay`** token — Use for modal and drawer backdrops instead of hardcoding rgba values.

## Changed
- **`Button`** — Loading state now shows a spinner instead of changing the label text. No migration needed, but custom loading labels will be ignored.
- **`spacing-3`** — Value changed from 10px to 12px to align with the 4px grid. Visual regression testing recommended.

## Fixed
- **`Select`** — Dropdown no longer clips inside overflow:hidden containers.
- **`Tooltip`** — Fixed flicker on rapid hover-unhover on Safari.

## Deprecated
- **`AlertBanner`** — Use `Banner` instead. Will be removed in v4.0. [Migration guide](/migration/alert-banner)
- **`color.text.muted`** — Renamed to `color.text.secondary`. Old name works but will warn in console.

## Breaking
- **BREAKING: `Modal` `size` prop** — Renamed from `width` to `size`. Accepts "sm" | "md" | "lg" instead of pixel values.
  Migration: Replace `<Modal width={400}>` with `<Modal size="sm">`.