Repository navigation
docs(changelog): adopt Keep a Changelog 1.1.0 - #6
Merged
Merged
Conversation
Add the standard preamble, an [Unreleased] section covering #3, #4 and #5 (Node floor declared as 22.13, Vitest 5, oxlint/oxfmt, Windows CI and format enforcement, the Windows test-harness fix), and comparison links for every version at the bottom. History is normalised, not rewritten: `## vX.Y.Z — title` becomes `## [X.Y.Z] - YYYY-MM-DD` with the old title kept as an italic lead line, dates taken from the release tags (and from the release commits for 0.2.0–0.3.0, which predate tagging). 0.5.3 gets a one-line entry: it was committed but never published to npm. The example README that deep-linked the old 0.5.0 heading points at the new anchor.
There was a problem hiding this comment.
🟢 Approval recommended
Documentation-only changes appear internally consistent (headings, anchors, and link references) and should not affect runtime behavior.
Pull request overview
Updates packages/groundflare/CHANGELOG.md to follow the Keep a Changelog 1.1.0 structure and adjusts an example README deep-link to match the new normalized heading anchor.
Changes:
- Add Keep a Changelog preamble + standardized
## [Unreleased]section and normalize historical release headings to## [X.Y.Z] - YYYY-MM-DD. - Add link reference definitions (compare links / commit links) for each version at the end of the changelog.
- Update
emdash-demoREADME to deep-link to the new0.5.0heading anchor.
File summaries
| File | Description |
|---|---|
| packages/groundflare/CHANGELOG.md | Adopts Keep a Changelog format with normalized version headings, an Unreleased section, and version link references. |
| packages/groundflare/examples/emdash-demo/README.md | Updates the changelog deep-link to the new normalized 0.5.0 heading anchor. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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
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.
Adopts https://keepachangelog.com/en/1.1.0/ for
packages/groundflare/CHANGELOG.md.## [Unreleased]with the changes merged today (Upgrade Vitest to v4 and fix workerd spawning on Windows (supersedes #2) #3, ci: run create-app and estimate check matrices on windows-latest #4, Move lint/format to oxlint + oxfmt, upgrade Vitest to 5 #5), comparison links for every version.## [X.Y.Z] - YYYY-MM-DD(dates from the release tags, or the release commits for 0.2.0–0.3.0 which predate tagging) with the old descriptive title kept as an italic lead line. 0.5.3 gets a one-line entry: committed but never published.Release flow going forward: move the
[Unreleased]entries under a new## [X.Y.Z] - dateheading and add its compare link.