Workflow Documentation

Write a Changelog Entry

Workflow for documenting changes in a release

documentationchangelogreleases
CLAUDE.md

When writing a changelog entry:

  1. Group changes by type: Added, Changed, Fixed, Removed, Deprecated, Security.
  2. Write each entry from the user’s perspective: what changed for them, not what code changed internally.
  3. Use past tense: “Added search filtering” not “Add search filtering.”
  4. Link to the relevant PR or issue for each entry.
  5. Include breaking changes at the top with migration instructions.
  6. Don’t include internal refactors, dependency bumps, or CI changes unless they affect users.

Copy this workflow into your CLAUDE.md or agent config file so your agent follows this process automatically.

get crystl