changelog-conventions
Skill568 starsChanged 3 months agoMITView on GitHub
Conventions for writing and updating CHANGELOG.md and GitHub release notes for zsh-patina. Use this skill when editing the changelog, adding new release entries, or updating GitHub release descriptions.
2 other projects use a version of this.
Adopted by
Most recently taken up by
- imchangchang/dsh-onetheir own version, first seen Oct 11, 2026
- lossless-group/lossless-agent-skillstheir own version, first seen Aug 15, 2026
Other versions2 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 2
- lossless-group/lossless-agent-skills★ 4same name
- imchangchang/dsh-one★ 1same 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.
The file
We split this skill into the rules it gives an agent
2 rules. About 0 are common, 1 is distinctive, and 1 is 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.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 48
Use reference-style links at the bottom of the file (e.g.
- Distinctive: line 54
Update a release with:
≈ “Common” is an estimate: at least 1 in 5 of the 372,429 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
CHANGELOG conventions for zsh-patina
Section structure
The project follows Semantic Versioning. Each release uses up to four sections, formatted as bold text (not Markdown headings), in this order:
**New features**— backwards-compatible additions; their presence requires at least a MINOR version bump**Breaking changes**— backwards-incompatible changes; their presence requires a MAJOR version bump**Bug fixes**— backwards-compatible fixes; present in PATCH and higher releases**Maintenance**— internal changes with no user-facing impact (e.g. dependency updates, refactoring, test improvements); present in any release
Omit sections that have no entries for a given release.
Version header format
Each release entry starts with a level-2 heading in this exact format:
## [X.Y.Z] - YYYY-MM-DDThe version number is always a reference link (e.g. [1.4.0]) pointing to the corresponding GitHub release. The reference link definition goes at the bottom of the file with the other version links.
Reference link ordering
Reference links at the bottom of the file are ordered as follows:
- Version links, newest to oldest (e.g.
[1.4.0],[1.3.1], …) - Issue and PR links (e.g.
[#10]) - Named links, alphabetically (e.g.
[Catppuccin],[Nord],[solarized], …)
Writing style
Begin each bullet point with a verb in the imperative mood (base form, no subject): Add, Fix, Improve, Update, etc. This follows the same convention as Git commit messages, where the implied subject is "this release".
Full stop rule
- Single-sentence bullet points: no trailing full stop
- Multi-sentence bullet points: use full stops on all sentences
Reference links
Use reference-style links at the bottom of the file (e.g. [Nord], [Catppuccin]).
GitHub release notes
Release notes on GitHub mirror the CHANGELOG entries exactly (same wording, same structure). When writing release notes via the GitHub CLI, expand reference-style links to inline links since the reference table at the bottom of the CHANGELOG is not available in that context.
Update a release with:
gh release edit <tag> --repo michel-kraemer/zsh-patina --notes-file <file>Contributor credits use the format (contributed by @username <emoji>), where the emoji is a fun or party-related one to praise the contributor (e.g. 🎉 🥳 🎊 🙌). The choice of emoji is informal and intentionally varied.
For people who suggested an idea, reported an issue, or otherwise contributed without writing code (e.g. a feature request or bug report), use the variant (thanks to @username for ... <emoji>), where ... briefly describes what they did (e.g. for this very useful feature request, for the idea, for the input, for the bug report). This keeps non-code contributions distinguishable from code contributions while still crediting them in the same inline style.
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.

