Changelog
Quick start
Read the existing changelog before editing it. Add human-curated notable changes
under ## [Unreleased] unless preparing a release, and group entries with Keep
a Changelog section names.
Workflow
- Read the relevant changelog document and nearby release history.
- Decide whether the change is notable to that changelog's audience.
- Add concise bullets under
## [Unreleased]. - Use only these section names:
Added,Changed,Deprecated,Removed,Fixed, andSecurity. - Keep entries human-readable; do not paste raw commit subjects or diffs.
- When preparing a release, move applicable
Unreleasedbullets into a new version section, use an ISO date such as2026-06-05, and keep latest releases first. - Run the repo's changelog or docs validation if one exists.
SemVer Mapping
MAJOR: incompatible public API or behavior changes.MINOR: backward-compatible public API additions, new functionality, or newly deprecated public API.PATCH: backward-compatible bug fixes.0.y.z: initial-development versions may change more freely, but still explain user-visible breakage clearly.
For breaking changes, make the impact explicit in the changelog entry and in the release version choice.
Standards
- Follow Keep a Changelog 1.1.0: https://keepachangelog.com/en/1.1.0/
- Follow Semantic Versioning 2.0.0: https://semver.org/spec/v2.0.0.html
- For private/public audience sanitation, use
publish-boundary.
Source: eunai/skills (MIT).