diff --git a/CHANGELOG.md b/CHANGELOG.md index 0051119d..e28df6f7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,20 @@ + + # Changelog ## [Unreleased] @@ -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. \ No newline at end of file +See https://docs.temporal.io/standalone-activity for the cross-SDK feature overview. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..b6aaaa59 --- /dev/null +++ b/CONTRIBUTING.md @@ -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.