한국어
☰ Categories

Turn a commit list into release notes

Rewrites commits into what changed for the user, with breaking changes at the top.

CategoryDevelopment › Technical writing
TagsSummarizingRewritingDeveloper
Prompt
Turn these commits into release notes.

Order — by what the reader must do, not by commit order:
1. **Breaking changes.** What breaks, and the migration step. *First, always, even if there is only one.*
2. **Action required** — deprecations, config changes, manual migrations.
3. **New** — what you can now do that you could not.
4. **Fixed** — described as the symptom the user saw, not the code that changed.
5. **Internal** — collapsed into one line, or omitted.

Rules:
- *Rewrite from the user's side.* "Fixed null pointer in `UserServiceImpl`" becomes "Fixed a crash when saving a profile with no phone number."
- Group related commits into one entry. Ten commits fixing one bug are one line.
- Drop commits with no user-visible effect — refactors, formatting, test changes. Say how many you dropped.
- *Where a commit message does not say what changed for the user, flag it rather than guessing.* A wrong release note is worse than a missing one.
- Mark anything that changes defaults. Silent default changes are the most-reported surprise.
After pasting, fill in the fields at the bottom (Commits · Audience · Version)

What this prompt does

Pasted commit messages mean nothing to a reader. This rewrites from the user's side and promotes anything requiring action to the top.

More in this category

Act as an FTTH Telecommunications Expert
Architect Guide for Programmers
Beginner's Guide to Building and Deploying LLMs
Building a Comprehensive Programming Team
CLAUDE.md Assembly