Agent skill

Release Notes Writer

by ArabelaTso in ArabelaTso/Skills-4-SE

Automatically generate user-facing release notes from git commits, pull requests, changelogs, and code changes.

Apache-2.0Auto-check passedDevelopment

Install Release Notes Writer

skills CLI
$ npx skills add ArabelaTso/Skills-4-SE --skill release-notes-writer -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install ArabelaTso/Skills-4-SE release-notes-writer --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/ArabelaTso/Skills-4-SE.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/release-notes-writer .claude/skills/release-notes-writer && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
release-notes-writer
GitHub stars
253
Token cost
~2.3k tokens
SKILL.md length
451 words
Files
1
Skills in repo
150
Repo updated
First seen
Licence
Apache-2.0

At a glance

Automatically generate user-facing release notes from git commits, pull requests, changelogs, and code changes.

  • Works in 6 steps: Gather Release Information → Extract Change Information → Categorize Changes → …
  • Preparing software releases
  • SKILL.md covers Overview, Workflow, Template Structure and Tips for Effective Release Notes
  • Calls git and gh

What it does

Release Notes Writer is an agent skill from ArabelaTso/Skills-4-SE. Automatically generate user-facing release notes from git commits, pull requests, changelogs, and code changes. Use when preparing software releases, creating version announcements, documenting what changed between versions, or communicating updates to users. Analyzes commit messages, PR descriptions, and code diffs to produce categorized markdown release notes organized by New Features, Improvements, Bug Fixes, and Breaking Changes. Focuses on user-visible changes while filtering out internal/technical details…

Its SKILL.md is about 2.3k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development, covering Changelog and release notes, Commit messages and Pull requests. The repository describes itself as: A curated list of 180+ useful Claude Skills for Software Engineering and resources for customizing AI for SE workflows. The licence is Apache-2.0.

When your agent uses it

  • Preparing software releases
  • Creating version announcements
  • Documenting what changed between versions
  • Communicating updates to users

Example prompts

  • “/release-notes-writer”

Requirements

  • Python 3

Workflow steps

6 steps, taken from the step headings in SKILL.md.

  1. Gather Release Information
  2. Extract Change Information
  3. Categorize Changes
  4. Filter for User-Facing Changes
  5. Generate Release Notes
  6. Write User-Friendly Descriptions

What it can do on your machine

Read from SKILL.md and the folder at commit 4f38503. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • git
    • gh

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md. Its commands use git and gh, which can reach the network depending on how they are called.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Release Notes Writer loads about 2.3k tokens when it runs. Until then it costs about 168 tokens; SKILL.md has 451 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~168
When it runs · the whole SKILL.md, loaded when a task matches
~2.3k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from ArabelaTso/Skills-4-SE at commit 4f38503, republished under its Apache-2.0 licence (© ArabelaTso). 451 words, ~2,294 tokens.

Download SKILL.mdSave it as .claude/skills/release-notes-writer/SKILL.md (or your agent's skills folder).
name
release-notes-writer
description
Automatically generate user-facing release notes from git commits, pull requests, changelogs, and code changes. Use when preparing software releases, creating version announcements, documenting what changed between versions, or communicating updates to users. Analyzes commit messages, PR descriptions, and code diffs to produce categorized markdown release notes organized by New Features, Improvements, Bug Fixes, and Breaking Changes. Focuses on user-visible changes while filtering out internal/technical details. Triggers when users ask to generate release notes, create changelog, write version announcement, or summarize changes for a release.

Release Notes Writer

Overview

Generate polished, user-facing release notes from git history, pull requests, and code changes, automatically categorizing and summarizing changes in a clear, accessible format.

Workflow

1. Gather Release Information

Collect the scope and sources for the release notes:

Define the release scope:

  • What version is being released? (e.g., v2.1.0)
  • What's the version range? (e.g., v2.0.0 to v2.1.0)
  • Which commits/PRs should be included?
  • Is this a major, minor, or patch release?

Quick commands to get started:

bash
# Get commits since last tag
git log $(git describe --tags --abbrev=0)..HEAD --oneline

# Get commits between two tags
git log v2.0.0..v2.1.0 --oneline

# Get commits since specific date
git log --since="2024-01-01" --oneline

# List all tags
git tag -l

# Get merged PRs (if using GitHub)
gh pr list --state merged --limit 50
2. Extract Change Information

Gather details from available sources:

From Git Commits
bash
# Get commit messages with details
git log v2.0.0..v2.1.0 --pretty=format:"%h - %s (%an)" --no-merges

# Get commits by author
git log v2.0.0..v2.1.0 --author="AuthorName" --oneline

# Get commit messages with full body
git log v2.0.0..v2.1.0 --format="%h %s%n%b%n"

Parse commit message conventions:

  • feat: or feature: → New Feature
  • fix: or bugfix: → Bug Fix
  • perf: or performance: → Performance Improvement
  • docs: or doc: → Documentation
  • refactor: → Code Quality/Refactoring
  • test: → Testing
  • chore: → Internal/Maintenance
  • BREAKING: or !: → Breaking Change
From Pull Requests

If using GitHub CLI:

bash
# Get merged PRs
gh pr list --state merged --limit 100 --json number,title,body,labels,mergedAt

# Get PR details
gh pr view <PR-NUMBER>

Extract from PR:

  • Title (often more user-friendly than commit message)
  • Description (may contain user-facing summary)
  • Labels (feature, bug, breaking-change, etc.)
  • Linked issues
From Changelog Files

Check for existing changelog entries:

bash
# Look for changelog files
find . -name "CHANGELOG.md" -o -name "HISTORY.md" -o -name "RELEASES.md"

# Check for unreleased section
grep -A 20 "Unreleased" CHANGELOG.md
From Code Diffs

Infer changes from code when commits lack detail:

bash
# See what files changed
git diff --stat v2.0.0..v2.1.0

# See what functions/classes were added
git diff v2.0.0..v2.1.0 --unified=0 | grep "^+def\|^+class"

# See API changes
git diff v2.0.0..v2.1.0 -- "*.py" | grep -E "^[+-]def |^[+-]class "
3. Categorize Changes

Organize changes into standard categories:

Category: ✨ New Features

User-visible new capabilities:

  • New API endpoints
  • New UI components
  • New configuration options
  • New supported platforms
  • New integrations

Examples:

  • "Added dark mode support"
  • "Introduced batch processing for large datasets"
Category: 🐛 Bug Fixes

Corrections to existing functionality:

  • Fixed crashes or errors
  • Corrected unexpected behavior
  • Resolved data inconsistencies
  • Fixed security vulnerabilities
Category: 🚀 Improvements

Enhancements to existing features:

  • Performance optimizations
  • Better error messages
  • Improved UX/UI
  • Enhanced reliability
Category: ⚠️ Breaking Changes

Changes requiring user action:

  • API signature changes
  • Removed features
  • Changed default behavior
  • Migration required
Show full SKILL.md (188 more words)Show less
4. Filter for User-Facing Changes

Include:

  • Changes users will notice
  • Changes users need to know about
  • Changes that affect how they use the product
  • Security fixes (user-facing impact)

Exclude or minimize:

  • Internal refactoring
  • Test additions
  • Build configuration changes
  • Code style updates
  • Developer tooling changes

Transform technical to user-friendly:

❌ "Refactored AuthService to use dependency injection"
✅ "Improved authentication reliability"

❌ "Updated webpack config for tree shaking"
✅ "Reduced bundle size by 20%"

❌ "Fixed race condition in concurrent processing"
✅ "Improved stability when processing multiple items simultaneously"
5. Generate Release Notes

Create formatted markdown output:

Template Structure

markdown
# Release Notes - Version X.Y.Z

**Release Date:** YYYY-MM-DD

## Summary

[1-3 sentence overview of the release]

---

## ✨ New Features

- **[Feature Title]**: [User-friendly description]
- **[Feature Title]**: [Description with benefit]

## 🚀 Improvements

- **[Improvement Title]**: [How this makes things better]
- **[Improvement Title]**: [Description]

## 🐛 Bug Fixes

- Fixed [issue description]
- Resolved [problem users were experiencing]

## ⚠️ Breaking Changes

- **[Breaking Change Title]**: [What changed and what users need to do]
  - **Migration:** [Step-by-step guidance]
  - **Before:** `code example`
  - **After:** `code example`

---

## 📊 Statistics

- X features added
- Y bugs fixed
- Z improvements made

## 🙏 Contributors

Thank you to all contributors who made this release possible:
- @username1
- @username2
6. Write User-Friendly Descriptions

Make each change clear and valuable:

Use active, benefit-focused language:

❌ "Added pagination to API"
✅ "You can now request data in pages, making it easier to work with large datasets"

❌ "Implemented OAuth2 authentication"
✅ "Sign in with your Google, GitHub, or Microsoft account"

❌ "Optimized database queries"
✅ "Reports now load 3x faster"

Be specific about impact:

❌ "Performance improvements"
✅ "Search results now appear in under 100ms, down from 2 seconds"

❌ "Better error handling"
✅ "Error messages now include specific suggestions for fixing the issue"

Include code examples for API changes:

markdown
### Breaking Change: Authentication Method Updated

**Before:**
```python
client = APIClient(session_token="abc123")

After:

python
client = APIClient(api_key="sk-abc123")

Migration: Update your initialization code to use the new api_key parameter.


### 7. Review and Polish

Before finalizing:

**Check completeness:**
- ✅ All significant changes included?
- ✅ Breaking changes clearly marked?
- ✅ User action items specified?
- ✅ Version number correct?

**Check clarity:**
- ✅ Descriptions are user-friendly, not technical?
- ✅ Benefits are clear?
- ✅ No internal jargon?
- ✅ Examples provided where helpful?

**Check organization:**
- ✅ Changes grouped logically?
- ✅ Most important changes listed first?
- ✅ Breaking changes prominently displayed?

## Example Output

```markdown
# Release Notes - Version 2.3.0

**Release Date:** February 15, 2026

## Summary

Version 2.3.0 brings enhanced search capabilities, performance improvements, and several bug fixes.

---

## ✨ New Features

- **Advanced Search Filters**: Filter search results by date, category, and status for more precise results
- **Keyboard Shortcuts**: Navigate the app faster with new keyboard shortcuts (press `?` to see all)
- **Export to Excel**: Export your data to Excel format in addition to CSV

## 🚀 Improvements

- **Faster Search**: Search results now appear instantly (improved from 2s to <100ms)
- **Better Mobile Experience**: Optimized interface for mobile devices
- **Smarter Autocomplete**: Autocomplete suggestions now learn from your previous searches

## 🐛 Bug Fixes

- Fixed issue where saving large files would occasionally fail
- Resolved problem with date picker not working in Safari
- Corrected timezone display for users in Asia-Pacific regions

---

## 📊 Statistics

- 3 new features
- 4 bugs fixed
- 3 improvements
- 47 commits
- 8 contributors

## 🙏 Contributors

Thank you to: @alice, @bob, @charlie, @diana, @eve, @frank, @grace, @henry

Tips for Effective Release Notes

Focus on user value:

  • What can users now do?
  • What problems were solved?
  • What's better/faster/easier?

Be honest about breaking changes:

  • Mark them prominently
  • Provide clear migration paths
  • Explain why the change was made

Use consistent language:

  • Present tense: "You can now..." not "You will be able to..."
  • Active voice: "Added feature" not "Feature was added"
  • User-centric: "You can" not "The system allows"

Group related changes:

  • Don't list every commit separately
  • Combine related fixes/features
  • Summarize multiple small improvements

Credit contributors:

  • Acknowledge community contributions
  • Thank external contributors
  • Build goodwill and engagement

© ArabelaTso, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in skills/release-notes-writer of ArabelaTso/Skills-4-SE.

Open the folder on GitHubat commit 4f38503

Compare with similar skills

Release Notes Writer next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Release Notes Writer compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Release Notes Writer this skillArabelaTso/Skills-4-SE253—~2.3kAutomated safety check: PassApache-2.0
Git Workflow and Versioningaddyosmani/agent-skills103k2 repos~3.5kAutomated safety check: NotesMIT
Verdaccio Pull Request Workflowverdaccio/verdaccio18k—~1.9kAutomated safety check: PassMIT
Commit And PR Messagessuperplanehq/superplane7.7k—~1.6kAutomated safety check: PassCustom licence
Plane Release Notes Generatormakeplane/plane61k—~2.5kAutomated safety check: PassAGPL-3.0
PR Pushicebear0828/codex-proxy1.8k—~2.2kAutomated safety check: NotesCustom licence

Similar skills

  • Git Workflow and Versioning

    addyosmani/agent-skills

    Sets git habits for every change: short-lived branches, atomic commits with descriptive messages, clean pull requests, plus versioning, tagging and changelogs for releases.

    103k GitHub starsUsed in 2 repos~3.5k tokens
    DevelopmentAuto-check: notes
  • Takes a change through a verdaccio pull request: branch, local checks, changeset, title and body, labels, CI and review rounds, and ports to other release lines.

    18k GitHub stars~1.9k tokensUpdated yesterday
    DevelopmentAuto-check passed
  • Commit And PR Messages

    superplanehq/superplane

    Write Git commit messages and pull request titles/descriptions using the Chris Beams / Tim Pope conventions (subject/body split, ~50-char subject, imperative mood, why-not-how body) plus ASD-STE100…

    7.7k GitHub stars~1.6k tokensUpdated today
    DevelopmentAuto-check passed
  • Builds categorized release notes for a Plane release pull request from its commits and writes them into the PR description, for both the plane-cloud and plane-ee repos.

    61k GitHub stars~2.5k tokensUpdated today
    DevelopmentAuto-check passed
  • PR Push

    icebear0828/codex-proxy

    Package the current working changes into a standards-compliant codex-proxy pull request: branch hygiene, commit message linting, CHANGELOG prompt, conventional commit, push, and gh pr create against…

    1.8k GitHub stars~2.2k tokensUpdated today
    DevelopmentAuto-check: notes
  • PR Push

    icebear0828/codex-proxy

    Package the current working changes into a standards-compliant codex-proxy pull request: branch hygiene, commit message linting, CHANGELOG prompt, conventional commit, push, and gh pr create against…

    1.8k GitHub stars~2.3k tokensUpdated today
    DevelopmentAuto-check: notes

More from ArabelaTso/Skills-4-SE

All 150 skills in this repo
  • Framework Migration Assistant

    ArabelaTso/Skills-4-SE

    Automatically migrate Python web applications between frameworks (Flask → FastAPI, Django → FastAPI).

    253 GitHub stars~1.9k tokensUpdated 1 mo ago
    Auto-check passed
  • Metamorphic Test Generator

    ArabelaTso/Skills-4-SE

    Generate test cases using metamorphic testing by applying transformations based on metamorphic properties.

    253 GitHub stars~798 tokensUpdated 1 mo ago
    Auto-check passed
  • Reproduction Trace Instrumenter

    ArabelaTso/Skills-4-SE

    Instruments programs to capture execution traces specifically for reproducing reported bugs, enabling consistent replay and diagnosis of failures.

    253 GitHub stars~2.4k tokensUpdated 1 mo ago
    Auto-check passed
  • Spring Mvc To Boot Migrator

    ArabelaTso/Skills-4-SE

    Automatically migrate Spring MVC applications to Spring Boot.

    253 GitHub stars~2.2k tokensUpdated 1 mo ago
    Auto-check passed
  • State Snapshot Instrumenter

    ArabelaTso/Skills-4-SE

    Instrument programs (Python, C/C++, Java) to capture snapshots of key program states at runtime, including variables, memory, and call stacks.

    253 GitHub stars~2.2k tokensUpdated 1 mo ago
    Auto-check passed

Categories

Questions about Release Notes Writer

What does Release Notes Writer do?

Automatically generate user-facing release notes from git commits, pull requests, changelogs, and code changes. Release Notes Writer is an agent skill from ArabelaTso/Skills-4-SE. Automatically generate user-facing release notes from git commits, pull requests, changelogs, and code changes.

When should I use Release Notes Writer?

Release Notes Writer fits situations like: preparing software releases; creating version announcements; documenting what changed between versions; communicating updates to users.

How do I install Release Notes Writer in Claude Code?

Run `npx skills add ArabelaTso/Skills-4-SE --skill release-notes-writer -a claude-code`. Or copy the skill folder (skills/release-notes-writer in ArabelaTso/Skills-4-SE) into .claude/skills/release-notes-writer in your project. Claude Code loads it when a task matches its description.

How do I install Release Notes Writer in Codex?

Run `npx skills add ArabelaTso/Skills-4-SE --skill release-notes-writer -a codex`. Or copy the skill folder (skills/release-notes-writer in ArabelaTso/Skills-4-SE) into .agents/skills/release-notes-writer in your project. Codex loads it when a task matches its description.

Can I use Release Notes Writer in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add ArabelaTso/Skills-4-SE --skill release-notes-writer -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/release-notes-writer, .gemini/skills/release-notes-writer, .github/skills/release-notes-writer and .opencode/skills/release-notes-writer in your project.

What does Release Notes Writer need to run?

Going by SKILL.md and its folder, Release Notes Writer needs the command-line tools its instructions call (git and gh). Our summary lists: Python 3.

Does Release Notes Writer access the network?

SKILL.md contains no URLs. Its commands use git and gh, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is Release Notes Writer safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Release Notes Writer use?

Release Notes Writer is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Release Notes Writer use?

About 2.3k tokens (SKILL.md is roughly 9.2k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Release Notes Writer?

Skills that share tags, products or a category with Release Notes Writer: Git Workflow and Versioning (addyosmani/agent-skills, 103k stars), Verdaccio Pull Request Workflow (verdaccio/verdaccio, 18k stars), Commit And PR Messages (superplanehq/superplane, 7.7k stars) and Plane Release Notes Generator (makeplane/plane, 61k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Release Notes Writer?

ArabelaTso (a GitHub user) maintains it in ArabelaTso/Skills-4-SE, which has 253 GitHub stars. The repository holds 150 skills in this directory. The repository was last updated on August 21, 2026.

Source: ArabelaTso/Skills-4-SE on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.