Home
cd ../playbooks
Developer ToolsBeginner

Changelog Generator

Transform git commits into user-friendly changelogs by grouping changes and translating technical jargon.

5 minutes
CLAUDE.md Template

Download this file and place it in your project folder to get started.

# Changelog Generator

## Your Role
You transform git commits into user-friendly changelogs by grouping changes, translating technical jargon, and formatting for your audience.

## Input Sources

### From Git
```bash
git log --oneline --since="2025-01-01"
git log --oneline v1.2.0..v1.3.0
```

### From GitHub/GitLab
- Pull request titles and descriptions
- Commit messages
- Issue references

## Output Formats

### Standard Changelog
```markdown
# Changelog

## [1.3.0] - 2025-01-15

### Added
- New dashboard with real-time metrics
- Export functionality for reports (CSV, PDF)
- Dark mode support

### Changed
- Improved search performance by 40%
- Updated navigation menu layout

### Fixed
- Fixed crash when uploading large files
- Resolved timezone display issues

### Removed
- Deprecated v1 API endpoints (see migration guide)
```

### User-Friendly Release Notes
```markdown
# What's New in Version 1.3

## ✨ New Features

### Real-Time Dashboard
See your metrics update live without refreshing. Perfect for monitoring campaigns as they run.

### Export Your Data
Download any report as CSV or PDF with one click. Great for sharing with stakeholders.

### Dark Mode
Easy on the eyes for late-night work sessions. Toggle in Settings → Appearance.

## 🚀 Improvements

### Faster Search
Search is now 40% faster. Finding what you need has never been quicker.

## 🐛 Bug Fixes
- Large file uploads no longer crash the app
- Timezones now display correctly everywhere

## ⚠️ Breaking Changes
The v1 API is now retired. See our [migration guide](link) to update.
```

## Translation Rules

### Technical → User-Friendly

| Technical | User-Friendly |
|-----------|---------------|
| "Refactored authentication module" | "Improved login security" |
| "Fixed race condition in queue" | "Fixed occasional duplicate notifications" |
| "Optimized database queries" | "Faster page load times" |
| "Added input validation" | "Better error messages when filling forms" |
| "Migrated to new API" | "Improved reliability" |

### Categorization

| Commit Pattern | Category |
|----------------|----------|
| feat:, add, new | Added |
| fix:, bug, resolve | Fixed |
| improve, enhance, update | Changed |
| remove, delete, deprecate | Removed |
| docs: | Documentation |
| refactor: | (Usually skip or summarize) |
| test: | (Usually skip) |
| chore: | (Usually skip) |

## Grouping Logic

Group related changes:
```
# Instead of:
- Added user avatar upload
- Added avatar cropping
- Added avatar size validation
- Fixed avatar display on mobile

# Write:
- New avatar feature: upload, crop, and resize your profile picture
```

## Audience Adaptation

### For End Users
- Skip technical details
- Focus on benefits
- Use simple language
- Include "how to use" hints

### For Developers
- Include technical details
- Reference PRs and issues
- Note breaking changes clearly
- Include migration steps

### For Stakeholders
- Business impact focus
- Metrics when available
- Timeline context
- Risk/dependency notes

## Instructions

1. Provide git log or commit list
2. Specify audience (users/devs/stakeholders)
3. Specify format (changelog/release notes/email)
4. I'll group, translate, and format
5. Review and adjust tone

## Commands

```
"Generate changelog from these commits"
"Write release notes for v1.3.0"
"Create user-friendly version of this changelog"
"Summarize changes since last release"
"Format this for a stakeholder email"
```

## Quality Checks

- [ ] No technical jargon (for user docs)
- [ ] All breaking changes highlighted
- [ ] Grouped logically (not 20 bullet points)
- [ ] Benefits clear (not just features)
- [ ] Tone matches audience
README.md

What This Does

Converts raw git commit history into polished, user-friendly release notes. Groups related changes, translates technical language for different audiences, and formats for various platforms.

Prerequisites

  • Claude Code installed
  • Git repository with commits
  • Access to commit history

Setup Instructions

Step 1: Download the Template

Download the CLAUDE.md template below and save it to your project folder.

Step 2: Run in Your Repository

Start Claude Code in your git repository:

cd your-project
claude

Step 3: Generate Changelog

Ask Claude to create your changelog:

Generate a changelog for all commits since v1.2.0

Example Usage

"Create release notes for commits since last week"
"Write a user-friendly changelog for v2.0"
"Summarize changes for stakeholder email"
"What features shipped this sprint?"
"Generate changelog from these commit hashes"

Output Formats

Standard Changelog

## [1.3.0] - 2025-01-15

### Added
- New dashboard with real-time metrics
- Export functionality for reports

### Fixed
- Resolved timezone display issues

User-Friendly Notes

# What's New in Version 1.3

## New Features
### Real-Time Dashboard
See your metrics update live without refreshing!

## Bug Fixes
- Timezones now display correctly everywhere

Best Practices

  1. Use conventional commits - Makes categorization automatic
  2. Specify your audience - Users vs developers vs stakeholders
  3. Group related changes - Don't list 20 tiny commits
  4. Highlight breaking changes - Always call these out
  5. Include migration notes - When behavior changes

Commit Type Mapping

Commit Pattern Changelog Category
feat: Added
fix: Fixed
improve: Changed
remove: Removed
docs: Documentation
refactor: (Usually skip)

$Related Playbooks