Skip to content

Add CHANGELOG and document the update process#453

Open
cconstable wants to merge 2 commits into
mainfrom
add-changelog
Open

Add CHANGELOG and document the update process#453
cconstable wants to merge 2 commits into
mainfrom
add-changelog

Conversation

@cconstable
Copy link
Copy Markdown

What

Adds a CHANGELOG.md and a lightweight process for keeping it current.

  • CHANGELOG.md at the repo root with an ## [Unreleased] section, loosely
    following the Keep a Changelog format.
    Entries are grouped under free-form headings (Added, Changed, Deprecated,
    Breaking Changes, Fixed, Security), created as needed.
  • .gitattributes marks CHANGELOG.md as merge=union so entries added by
    concurrent PRs append instead of conflicting.
  • CONTRIBUTING.md documents when to add an entry (any user-facing change)
    and how.

Why

Today release drivers reconstruct notes by hand at release time. Capturing
high-level notes incrementally in each PR makes releases faster and more
reliable: the GitHub release notes become the [Unreleased] section plus the
commit log.

Notes

  • Docs and config only; no code or behavior changes. The changelog starts fresh;
    historical release notes remain available through GitHub Releases.
  • We can backfill the changelog if necessary.

@cconstable cconstable marked this pull request as ready for review June 4, 2026 18:02
@cconstable cconstable requested a review from a team as a code owner June 4, 2026 18:02
Add a CHANGELOG.md with an Unreleased section, set CHANGELOG.md to merge=union via .gitattributes, and document in CONTRIBUTING.md when and how to add entries.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant