docs: add CHANGELOG.md (Keep a Changelog) with an [Unreleased] section - #232
Merged
Conversation
Release notes have lived only in annotated git tags, so there was no single place to see what's merged-but-unpublished. Add a CHANGELOG.md in Keep a Changelog format: an [Unreleased] section at the top (currently the module AGENT.md scaffold change) followed by every tagged release v2.0.0 -> v2.5.1, backfilled from the tag annotations, with compare links. Document the convention in CLAUDE.md (every user-facing change adds an [Unreleased] bullet; on release, roll it into a dated [vX.Y.Z] section, add a fresh [Unreleased], update the compare links, and reuse the section as the annotated-tag body) and point to it from the README contributing section.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a
CHANGELOG.mdin Keep a Changelog format and adopts it as the source of truth for release notes.## [Unreleased]at the top shows what's merged tomasterbut not yet tagged — currently the moduleAGENT.mdscaffold change (scaffold: ship an AGENT.md in the module skeleton so agents know the Univeros conventions #230, re #230 feat(scaffold): ship an AGENT.md in the module skeleton #231).v2.0.0→v2.5.1backfilled from the existing annotated-tag bodies, grouped Added / Changed / Fixed, with PR/issue references andcomparelinks.Why
Release notes have lived only in annotated git tags, so there was no single place to see merged-but-unpublished changes (the thing Laravel's
[Unreleased]section gives you).Convention (documented in CLAUDE.md §6, linked from the README)
## [Unreleased](Added / Changed / Fixed / Removed / Deprecated / Security) referencing its PR/issue.[Unreleased]→[vX.Y.Z] - YYYY-MM-DD, add a fresh empty[Unreleased], update the compare links, and reuse that version's section as the annotated-tag body. The CHANGELOG now folds into the tag + split flow.Notes
Test plan
CHANGELOG.md,CLAUDE.md,README.mdrender correctly; compare links well-formed.