writing-changelogs
Skill10 starsChanged 44 days agoMITView on GitHub
Guides the writing and editing of changelog entries in the per-module CHANGELOG.md files. Use when a user-facing change needs an entry, when drafting or reshaping an Unreleased section, or when reviewing entries at release time. Covers the type headings, the entry shape and the succinctness bar - what an entry says and what it leaves to the docs.
2 other projects use a version of this.
Adopted by
Most recently taken up by
- dork-labs/dorkostheir own version, first seen Sep 26, 2026
- martinkup/symfony-profiler-optimization-advisor-bundletheir own version, first seen Mar 7, 2026
Other versions2 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 2
- martinkup/symfony-profiler-optimization-advisor-bundle★ 45same name
- dork-labs/dorkos★ 11same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository7 other files it gives its agents.
The file
Files
The following document will be helpful:
| Document | For |
CHANGELOG.md | The repository's changelog conventions: the deviations from Keep a Changelog, the unreleased-heading rules, the humans-and-machines philosophy and the entry shape with its exemplar. |
Each published module owns a CHANGELOG.md beside its code, and a user-facing change adds its entry alongside the change it describes.
The entry speaks to a consumer deciding whether and how to upgrade. One lead line names the surface, terse bullets name the exported identifiers, and everything discoverable from the identifiers themselves - signatures, field lists, wire behavior, doc-comment content - stays out. When more depth genuinely helps, link the canonical source rather than restating it.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.