skills.rest
mark-torres10
mark-torres10COMMUNITY
Explore all skills by this author →
GitHub

write-changelog

Writes terse, outcome-focused CHANGELOG entries for merged pull requests.

3|Updated Feb 15, 2025
Search Tags:#changelog#documentation#writing#markdown#pull request#github#release notes
One-click install
npx skills add https://github.com/mark-torres10/ai_tools --skill write-changelog-mark-torres10
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: write-changelog
Source: https://github.com/mark-torres10/ai_tools/tree/main/skills/write-changelog
Command: npx skills add https://github.com/mark-torres10/ai_tools --skill write-changelog-mark-torres10

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Keeping a CHANGELOG.md up to date is tedious: PR descriptions are verbose and full of implementation detail, while a changelog should be a readable, executive-style history of what shipped. This Skill turns merged PRs into concise, outcome-focused changelog entries without manual summarization. ## Core Features & Use Cases - PR-to-Changelog Summarization: Reads PR context (title, body, diff summary) and drafts 1-2 sentence entries that lead with system or user impact. - Consistent Formatting: Groups entries under ## YYYY-MM-DD date headings, numbers them, and always appends the PR link, following a concrete example file. - Editorial Guardrails: Strips implementation rationale, version labels, and "not yet done" narration so entries stay terse and outcome-focused. - Use Case: After merging PR #58, ask for a changelog entry and get a dated, numbered line like "Updated feedback UI to ten category labels. PR #58" appended to CHANGELOG.md. ## Quick Start Ask the assistant to write a CHANGELOG entry for a specific merged PR, providing the PR number and link.

Frequently Asked Questions about write-changelog

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write a changelog entry for a merged PR?▼

Provide the PR number, URL, and a summary of what merged. The Skill drafts 1-2 outcome-focused sentences, appends the PR link, and adds the entry under the correct date heading in CHANGELOG.md.

What format should a CHANGELOG entry follow?▼

Entries are grouped under a ## YYYY-MM-DD heading, numbered, and limited to 1-2 sentences leading with system or user impact. Each entry ends with a PR link in the form [PR #N](url), with newest dates at the top.

Can I use this for PR descriptions or weekly status updates?▼

No. The Skill explicitly excludes PR descriptions (use a write-pr-description skill instead) and weekly status writeups unless you explicitly want CHANGELOG format. It only summarizes work that actually shipped.

What content gets excluded from changelog entries?▼

Entries cut implementation rationale, file-by-file digests, design narration, version labels like "V1", and "what it doesn't do yet" statements. Libraries or tools are mentioned only when central to the change.

Does it create CHANGELOG.md if the file is missing?▼

Yes. The workflow creates the CHANGELOG.md file or the date heading if either is missing, then appends the new entry under today's or the PR's merge date.

Related Skills

Explore More Software Engineering Skills→
multigresmultigres
2.6k

draft-pr

Generates a PR title and description from the branch diff and creates a draft pull request.

Official
Basic
SokoliemSokoliem

release

Generate release notes and changelog entries from commit history and PR metadata.

Community
Advanced
MetaMaskMetaMask
3.0k

pr-description

Generate a PR description from git diffs and branch names.

Official
Advanced
Tonybleything76Tonybleything76

Changelog Generator

Generate changelog entries from Git commit history using Conventional Commits.

Community
Advanced