Draft a Developer Changelog from Raw Commits
Back to prompts
Draft a Developer Changelog from Raw Commits
writingintermediateClaudeGPTGemini
writing
Transform raw git commit messages or pull request titles into a structured, reader-friendly changelog categorized by impact.
Prompt
You are an expert technical writer and developer advocate. Your task is to transform a raw list of git commits, pull request titles, or developer notes into a clean, structured, and professional changelog for version {{version_number}}.
Here is the context for this release:
- **Target Audience:** {{target_audience}} (e.g., API consumers, end-users, internal product team, general public)
- **Key Theme/Focus of this Release:** {{release_focus}} (e.g., security hardening, performance improvements, UI overhaul, or leave blank if none)
Here is the raw commit history or release notes:
---
{{raw_commits_or_notes}}
---
Please analyze the input and generate the changelog according to the following strict guidelines:
### 1. Structure of the Output
Your response must follow this exact structure:
- **Executive Summary:** A 2-3 sentence overview of what this release achieves, written specifically for the target audience: {{target_audience}}.
- **⚠️ Breaking Changes:** (Only include this section if there are breaking changes. Clearly explain what broke, why, and what migration action is required. If none, omit this section entirely.)
- **🚀 New Features:** Bulleted list of new capabilities. Focus on user value, not just code changes.
- **🔧 Improvements & Refactors:** Bulleted list of performance boosts, optimizations, and non-breaking structural changes.
- **🐛 Bug Fixes:** Bulleted list of resolved issues. State what the bug was and how it was fixed (e.g., "Fixed a race condition that caused X when doing Y").
- **❓ Unclear / Action Required:** A list of any commits or notes that were too vague, cryptic, or lacked context (e.g., "fix typo", "update", or hash-only commits) to categorize. Do not guess their meaning; list them here so I can clarify them manually.
### 2. Tone and Style Rules
- Write in the active voice and present tense (e.g., "Adds validation support" instead of "Added validation support").
- Group related commits together into single, cohesive bullet points rather than listing every single commit line-by-line.
- Translate low-level technical jargon into clear benefits based on the target audience.
- Keep it concise. No conversational filler or introductory/concluding remarks outside of the requested structure.When to use this
Use this prompt when preparing a new software release and you need to compile messy git commit histories, PR titles, or developer notes into a polished, structured changelog. It bridges the gap between raw technical commits and user-facing documentation, saving manual editing time.
Tips
- For best results, strip out merge commits and automated dependency updates (like Dependabot) before pasting, unless you specifically want them documented.
- If the generated changelog misses the business context of a feature, reply with the specific PR description for that feature and ask the model to rewrite just that section.