skills/changelog-writing/SKILL.md
Write and maintain changelogs following the Keep a Changelog convention. Use when creating a CHANGELOG.md, adding entries for a release, or reviewing changelog format and completeness.
npx skillsauth add kjanat/skills changelog-writingInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
Write changelogs for humans, not machines. Follow the Keep a Changelog convention.
CHANGELOG.md at project rootYYYY-MM-DD)Group changes under these headings, in this order:
| Category | Use for |
| ------------ | ---------------------------------- |
| Added | New features |
| Changed | Changes to existing functionality |
| Deprecated | Features marked for future removal |
| Removed | Features removed in this release |
| Fixed | Bug fixes |
| Security | Vulnerability patches |
Omit empty categories. Never invent new category names.
Always keep an ## [Unreleased] section at the top:
## [Unreleased]
### Added
- New user profile endpoint.
At release time, move Unreleased entries into a new versioned heading.
## [1.2.0] - 2025-08-15
Yanked releases append [YANKED]:
## [1.1.0] - 2025-07-01 [YANKED]
At the bottom of the file, define diff links for every version:
[Unreleased]: https://github.com/org/repo/compare/v1.2.0...HEAD
[1.2.0]: https://github.com/org/repo/compare/v1.1.0...v1.2.0
[1.1.0]: https://github.com/org/repo/releases/tag/v1.1.0
| Don't | Why |
| -------------------------- | ------------------------------------------- |
| Dump git log as changelog | Noise: merge commits, docs changes, typos |
| Skip deprecation notices | Users can't prepare for breaking changes |
| Use regional date formats | Ambiguous (01/02/03). Use ISO 8601 |
| Document only some changes | Partial changelog is worse than none |
| Use GitHub Releases alone | Non-portable, less discoverable than a file |
| Task | Files to Read | | -------------------- | ----------------------- | | Create new CHANGELOG | SKILL.md + example.md | | Add release entries | SKILL.md (categories) | | Review format | SKILL.md (format rules) | | See full example | example.md |
| File | Purpose | | ----------------------------------- | -------------------------- | | example.md | Complete example changelog |
development
Use this skill whenever the user is designing, building, scaffolding, reviewing, or debugging Go-based reverse proxy or HTTP edge infrastructure, especially when they mention statute, config-as-code proxies, building an nginx replacement in Go, networking topology, TLS termination, load balancing, HTTP/2, HTTP/3, QUIC, ACME, upstream pools, middleware chains, or graceful shutdown. Trigger this skill even when the user does not explicitly name statute but is clearly working on a Go HTTP server, edge proxy, or networking infrastructure problem where the resulting artefact will be a compiled binary rather than a runtime-configured server. Also trigger when the user asks for explanations of networking protocols (HTTP/1.1, HTTP/2, HTTP/3, WebSockets, gRPC, TLS) in the context of building or operating a proxy, or when they ask about Go net/http pitfalls, transport tuning, or production-grade server defaults.
development
Routes Threlte questions to exact, commit-pinned docs paths and practical workflows. Use when helping with setup, debugging, or architecture across @threlte/core, @threlte/extras, @threlte/gltf, @threlte/rapier, @threlte/theatre, @threlte/xr, @threlte/flex, and @threlte/studio.
testing
Comprehensive lightning physics knowledge base derived from Rakov & Uman (2003) "Lightning: Physics and Effects". Covers discharge types, current parameters, leader/return-stroke physics, cloud electrification, protection, detection systems, atmospheric effects, and quantitative reference data. Use when answering questions about lightning physics, electromagnetic fields, thunderstorm electricity, lightning protection, or atmospheric electrical phenomena.
development
Generate hierarchical AGENTS.md knowledge base for a codebase. Creates root + complexity-scored subdirectory documentation.