mcpField
R
release-notes-composer

release-notes-composer

github.com/qodex-aiDevelopment47132 installsUpdated 42w ago
Repository

About release-notes-composer

release-notes-composer turns Git commits into user-facing changelogs, scoped by date range or version. It categorizes changes, filters internal commits, and formats the result to match specified guidelines for product releases and updates.

Key features

  1. 01Scans Git history by selected scope
  2. 02Groups changes by category
  3. 03Rewrites technical commits for users
  4. 04Filters internal commit noise
  5. 05Formats notes to brand guidelines

Use cases

  1. 01Write notes for a new release
  2. 02Summarize weekly or monthly product updates
  3. 03Prepare app store update descriptions
  4. 04Maintain a public product updates page

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/qodex-ai/ai-agent-skills --skill release-notes-composer

After installing, type/release-notes-composerin Claude Code to confirm it loaded.

Details

From the project README

Changelog Generator

This skill transforms technical git commits into polished, user-friendly changelogs that your customers and users will actually understand and appreciate.

When to Use This Skill

  • Preparing release notes for a new version
  • Creating weekly or monthly product update summaries
  • Documenting changes for customers
  • Writing changelog entries for app store submissions
  • Generating update notifications
  • Creating internal release documentation
  • Maintaining a public changelog/product updates page

What This Skill Does

  1. Scans Git History: Analyzes commits from a specific time period or between versions
  2. Categorizes Changes: Groups commits into logical categories (features, improvements, bug fixes, breaking changes, security)
  3. Translates Technical → User-Friendly: Converts developer commits into customer language
  4. Formats Professionally: Creates clean, structured changelog entries
  5. Filters Noise: Excludes internal commits (refactoring, tests, etc.)
  6. Follows Best Practices: Applies changelog guidelines and your brand voice

How to Use

Basic Usage

From your project repository:

Create a changelog from commits since last release

Generate changelog for all commits from the past week

Create release notes for version 2.5.0
With Specific Date Range
Create a changelog for all commits between March 1 and March 15
With Custom Guidelines
Create a changelog for commits since v2.4.0, using my changelog 
guidelines from CHANGELOG_STYLE.md

Example

User: "Create a changelog for commits from the past 7 days"

Output:

# Updates - Week of March 10, 2024

## ✨ New Features

- **Team Workspaces**: Create separate workspaces for different 
  projects. Invite team members and keep everything organized.

- **Keyboard Shortcuts**: Press ? to see all available shortcuts. 
  Navigate faster without touching your mouse.

## 🔧 Improvements

- **Faster Sync**: Files now sync 2x faster across devices
- **Better Search**: Search now includes file contents, not just titles

## 🐛 Fixes

- Fixed issue where large images wouldn't upload
- Resolved timezone confusion in scheduled posts
- Corrected notification badge count

Inspired by: Manik Aggarwal's use case from Lenny's Newsletter

Tips

  • Run from your git repository root
  • Specify date ranges for focused changelogs
  • Use your CHANGELOG_STYLE.md for consistent formatting
  • Review and adjust the generated changelog before publishing
  • Save output directly to CHANGELOG.md

Related Use Cases

  • Creating GitHub release notes
  • Writing app store update descriptions
  • Generating email updates for users
  • Creating social media announcement posts

Comments

Markdown supported