From 6a6dead7ccb59c42ca7b026a63bb6a767ed1cabb 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 | 20 ++++++++++++++++++++ CONTRIBUTING.md | 21 +++++++++++++++++++++ 3 files changed, 42 insertions(+) create mode 100644 .gitattributes create mode 100644 CHANGELOG.md create mode 100644 CONTRIBUTING.md diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 000000000..a19ade077 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +CHANGELOG.md merge=union diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000..e79c14272 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,20 @@ +# Changelog + +## [Unreleased] + + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..83b27f007 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,21 @@ +# Contributing to the Temporal Python SDK + +Thanks for your interest in contributing! + +All contributors must complete the Temporal Contributor License Agreement (CLA) before changes +can be merged. A link to the CLA will be posted in the PR. + +See the [README](README.md) for build and development instructions. + +## 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 794a294d2b08172f9de2dae348024a8351f4c478 Mon Sep 17 00:00:00 2001 From: Chris Constable Date: Thu, 4 Jun 2026 14:44:53 -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 e79c14272..074191972 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,3 @@ -# Changelog - -## [Unreleased] - + +# Changelog + +## [Unreleased]