From eaea33517528a07dc85eb9bfce5c102b24d4aa79 Mon Sep 17 00:00:00 2001 From: Chris Constable Date: Thu, 4 Jun 2026 13:53:32 -0400 Subject: [PATCH 1/2] Add CHANGELOG and document the update process 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. --- .gitattributes | 1 + CHANGELOG.md | 23 +++++++++++++++++++++++ CONTRIBUTING.md | 14 ++++++++++++++ 3 files changed, 38 insertions(+) create mode 100644 .gitattributes create mode 100644 CHANGELOG.md diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000000..a19ade077d --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +CHANGELOG.md merge=union diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000000..e44bd425d9 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,23 @@ +# Changelog + +Release notes for versions released before this file was introduced are archived +under [`releases/`](releases/). + +## [Unreleased] + + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5b0c1a0fd7..19cab62248 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -80,3 +80,17 @@ softwareupdate --install-rosetta ``` for builds to complete successfully. + +## Changelog + +User-facing changes are recorded in [`CHANGELOG.md`](CHANGELOG.md), loosely following the +[Keep a Changelog](https://keepachangelog.com/en/1.1.0/) format. (Release notes for older versions +are archived under [`releases/`](releases/).) + +If your PR includes a user-facing change (new feature, behavior change, deprecation, breaking +change, notable bug fix, or security fix), add a short, high-level entry to the `## [Unreleased]` +section at the top of `CHANGELOG.md` under the appropriate heading, creating it if needed: +Added, Changed, Deprecated, Breaking Changes, Fixed, or Security. + +Keep entries high-level and written for users. The full commit log is appended at release time, +so internal-only changes (refactors, tests, CI, docs) don't need an entry. From 56d3aeed90285b3dbdcd72684809bc717d360470 Mon Sep 17 00:00:00 2001 From: Chris Constable Date: Thu, 4 Jun 2026 14:44:52 -0400 Subject: [PATCH 2/2] Move changelog comments to top of file for better readability. --- CHANGELOG.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e44bd425d9..945d2b36e4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,10 +1,3 @@ -# Changelog - -Release notes for versions released before this file was introduced are archived -under [`releases/`](releases/). - -## [Unreleased] - + +# Changelog + +Release notes for versions released before this file was introduced are archived +under [`releases/`](releases/). + +## [Unreleased]