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..945d2b36e4 --- /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.