write-a-changelog
Skill1 starsChanged 3 months agoMITView on GitHub
When a repo has no changelog or an outdated one. Triggers: 'add a changelog', 'CHANGELOG.md', 'keep a changelog', 'release notes'. Adds a Keep a Changelog file and keeps an Unreleased section current.
In this repository16 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- add-testsSkill
- cut-a-releaseSkill
- env-and-configSkill
- license-and-legalSkill
- lint-and-formatSkill
- one-command-runSkill
- package-for-npmSkill
- package-for-pypiSkill
- readme-that-convertsSkill
- repo-hygiene-passSkill
- security-basicsSkill
- set-up-ciSkill
- ship-checklistSkill
- ship-contextSkill
The file
We split this skill into the rules it gives an agent
1 rule. About 0 are common, 1 is distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 19
Seed from git history: if starting fresh, but write for humans: group by what a user cares about, not raw commits.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Write a Changelog
A changelog tells users what changed and whether to upgrade. You add one in the standard format and keep it honest.
Before you start
Read .agents/ship.md.
Steps
- Use Keep a Changelog format: a top
## [Unreleased], then released versions newest-first, each withAdded / Changed / Fixed / Removedas needed. - Seed from git history if starting fresh, but write for humans: group by what a user cares about, not raw commits.
- Keep Unreleased current as you work, so cutting a release is just renaming the section to the version and date.
- Link versions to their diff or compare URLs.
Done when
CHANGELOG.md exists in Keep a Changelog format with an Unreleased section, and cut-a-release can turn it into release notes.
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.