From 7dbe65625064c3cab6af89da161e87b7564b6076 Mon Sep 17 00:00:00 2001 From: Chris Constable Date: Thu, 4 Jun 2026 13:53:33 -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, 35 insertions(+), 3 deletions(-) create mode 100644 .gitattributes 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 index c941080776..e79c142725 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,20 @@ -Release notes are now published exclusively through our -[GitHub release page](https://github.com/temporalio/sdk-typescript/releases). -This file is no longer maintained. +# Changelog + +## [Unreleased] + + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1738575451..5122329794 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,6 +17,7 @@ - [test-npm-init](#test-npm-init) - [Style Guide](#style-guide) - [Updating and pruning dependencies](#updating-and-pruning-dependencies) +- [Changelog](#changelog) @@ -205,3 +206,16 @@ done ``` To install both tools: `npm i -g npm-check npm-check-updates`. + +## 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. + +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 0247201422d0d3dd1b5c27547a4057095ee56967 Mon Sep 17 00:00:00 2001 From: Chris Constable Date: Thu, 4 Jun 2026 14:44:55 -0400 Subject: [PATCH 2/2] Move changelog comments to top of file for better readability. --- CHANGELOG.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e79c142725..0741919729 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,3 @@ -# Changelog - -## [Unreleased] - + +# Changelog + +## [Unreleased]