skills.rest
DataDog
DataDogOFFICIAL
Explore all skills by this author →
Website𝕏@datadoghqGitHub

write-changelog

Write customer-facing changelog fragments for Ruby gem pull requests.

417|417|Updated Aug 24, 2016
Search Tags:#changelog#documentation#pull request#release notes#gem#ruby#rake
One-click install
npx skills add https://github.com/DataDog/dd-trace-rb --skill write-changelog-datadog
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: write-changelog
Source: https://github.com/DataDog/dd-trace-rb/tree/main/.claude/skills/write-changelog
Command: npx skills add https://github.com/DataDog/dd-trace-rb --skill write-changelog-datadog

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Maintainers of the dd-trace-rb gem need consistent, customer-facing changelog entries for every user-visible change, but writing grounded, well-scoped entries from a PR diff is error-prone and easy to skip. ## Core Features & Use Cases - Grounded Fragment Authoring: Derives each entry's effect, product, and type (Added/Changed/Fixed) directly from the PR diff, tests, and benchmark evidence. - Style and Structure Enforcement: Applies rules for present-tense imperative openings, symptom-plus-trigger phrasing, exact versions, and escape hatches, validated with bundle exec rake unreleased:lint and unreleased:vale. - Use Case: A PR fixing a TypeError from Process.spawn is about to merge; the skill triages the diff, scaffolds a fragment with bundle exec rake unreleased:new, and produces an entry like "Fix TypeError from Process.spawn when passing an environment Hash." ## Quick Start Write a changelog fragment for the approved PR that changes user-visible behavior in this repository.

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 Ruby gem pull request?▼

Read the PR diff to identify the customer-facing effect, then scaffold a fragment with bundle exec rake unreleased:new. Write the message in present-tense imperative form, lead with the observable effect, and validate with bundle exec rake unreleased:lint and unreleased:vale.

When should a changelog fragment be added for a PR?▼

Add a fragment for new features, behavior changes, and customer-affecting bug fixes. Skip internal refactors, test-only changes, CI or tooling work, and docs outside docs/GettingStarted.md. When unsure, add one since a reviewer can delete it.

What changelog types does the fragment system support?▼

Fragments use three types: Added for new capabilities, Changed for behavior changes including performance changes, and Fixed for bug fixes. Each type has its own message structure, such as symptom plus trigger for Fixed entries.

Can one pull request produce multiple changelog fragments?▼

Yes, but only when the PR contains several distinct customer-facing effects. Each effect gets its own fragment after confirming the split with the user; never bundle multiple effects into a single entry.

Why does changelog grounding require tests in the diff?▼

Behavioral claims must trace to evidence: a diff hunk, benchmark output, or a test. Without a test, the entry can only claim what inspection establishes, and reproducible defects should prompt a request to add the missing test.

Related Skills

Explore More Software Engineering Skills→
semantic-praxissemantic-praxis

pr-review

Reviews barwise pull requests and produces a verified merge recommendation with ranked findings.

Official
Advanced
UKGovernmentBEISUKGovernmentBEIS
657

prepare-release

Prepares an inspect_evals release by collecting changelog fragments and opening a draft PR.

Official
Intermediate
JYeswakJYeswak

pr-verify

Verifies patches by running the reproduction before and after the change.

Community
Intermediate
co-labs-coco-labs-co
1

conventional-commits-release

Validate commit messages and PR titles with commitlint for automated semantic-release versioning.

Official
Intermediate