Skip to content

Add CHANGELOG and document the update process #453

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cconstable wants to merge 2 commits into
base: main
Choose a base branch
from
+39 −1
Open

Add CHANGELOG and document the update process #453

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a44a6f8
Add CHANGELOG and document the update process
cconstable Jun 4, 2026
2c9f133
Move changelog comments to top of file for better readability.
cconstable Jun 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
<!--
High-level release notes.
Loosely based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).

When your PR includes a user-facing change, add an entry below under the
appropriate heading (create the heading if it does not yet exist). Within
each heading content can be free-form. Feel free to include examples, links
to docs, or any other relevant information.

### Added — new features
### Changed — changes in existing functionality
### Deprecated — soon-to-be-removed features
### Breaking Changes — removed or backwards-incompatible features
### Fixed — notable bug fixes
### Security — notable security fixes
-->

# Changelog

## [Unreleased]
Expand Down Expand Up @@ -28,4 +45,4 @@ and `Client#count_activities` provide visibility-backed queries; and `Client#asy
accepts a standalone-form `ActivityIDReference` (constructed via `ActivityIDReference.for_standalone`) for
async completion.

See https://docs.temporal.io/standalone-activity for the cross-SDK feature overview.
See https://docs.temporal.io/standalone-activity for the cross-SDK feature overview.
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Contributing to the Temporal Ruby 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.
Loading