Skip to content

Commit b217b36

Browse files
authored
Add CHANGELOG and document the update process (#1580)
* 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. * Move changelog comments to top of file for better readability.
1 parent bda846f commit b217b36

3 files changed

Lines changed: 42 additions & 0 deletions

File tree

.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
CHANGELOG.md merge=union

CHANGELOG.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<!--
2+
High-level release notes.
3+
Loosely based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
4+
5+
When your PR includes a user-facing change, add an entry below under the
6+
appropriate heading (create the heading if it does not yet exist). Within
7+
each heading content can be free-form. Feel free to include examples, links
8+
to docs, or any other relevant information.
9+
10+
### Added — new features
11+
### Changed — changes in existing functionality
12+
### Deprecated — soon-to-be-removed features
13+
### Breaking Changes — removed or backwards-incompatible features
14+
### Fixed — notable bug fixes
15+
### Security — notable security fixes
16+
-->
17+
18+
# Changelog
19+
20+
## [Unreleased]

CONTRIBUTING.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Contributing to the Temporal Python SDK
2+
3+
Thanks for your interest in contributing!
4+
5+
All contributors must complete the Temporal Contributor License Agreement (CLA) before changes
6+
can be merged. A link to the CLA will be posted in the PR.
7+
8+
See the [README](README.md) for build and development instructions.
9+
10+
## Changelog
11+
12+
User-facing changes are recorded in [`CHANGELOG.md`](CHANGELOG.md), loosely following the
13+
[Keep a Changelog](https://keepachangelog.com/en/1.1.0/) format.
14+
15+
If your PR includes a user-facing change (new feature, behavior change, deprecation, breaking
16+
change, notable bug fix, or security fix), add a short, high-level entry to the `## [Unreleased]`
17+
section at the top of `CHANGELOG.md` under the appropriate heading, creating it if needed:
18+
Added, Changed, Deprecated, Breaking Changes, Fixed, or Security.
19+
20+
Keep entries high-level and written for users. The full commit log is appended at release time,
21+
so internal-only changes (refactors, tests, CI, docs) don't need an entry.

0 commit comments

Comments
 (0)