From ff13a11911970fccb9e7c2d64da93b226f1c0801 Mon Sep 17 00:00:00 2001 From: Joshua Young Date: Sat, 17 Oct 2026 10:11:51 +1100 Subject: [PATCH 1/2] Document that release notes are generated from pull requests The CHANGELOG has been updated at release time since 1.3.6, with each version linking to its generated GitHub release notes, so contributors no longer need to edit it. --- .github/CONTRIBUTING.md | 4 ++-- README.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 0f6450e5c..575a71331 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -104,9 +104,9 @@ git rebase upstream/master git push origin my-feature-branch -f ``` -#### Update CHANGELOG +#### Release Notes -Update the [CHANGELOG](../CHANGELOG.md) with a description of what you have changed. +Release notes are generated from the titles of merged pull requests, so give your pull request a title that describes the change. There is no need to update the [CHANGELOG](../CHANGELOG.md); maintainers update it when releasing. #### Check on Your Pull Request diff --git a/README.md b/README.md index daf3eac5a..aa4fe2194 100644 --- a/README.md +++ b/README.md @@ -364,7 +364,7 @@ best practice is to depend on `concurrent-ruby` and let users to decide if they ### Publishing the Gem * Update `version.rb` -* Update the CHANGELOG +* Update the CHANGELOG with a section for the new version linking to its GitHub release notes * Add the new version to `docs-source/signpost.md`. Needs to be done only if there are visible changes in the documentation. * Commit (and push) the changes. * Use `bundle exec rake release` to release the gem. From 2a7b24c8aaa2fa964066bae36cefeec1dd8793f0 Mon Sep 17 00:00:00 2001 From: Joshua Young Date: Sat, 17 Oct 2026 10:31:28 +1100 Subject: [PATCH 2/2] End every Publishing the Gem step with a period --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index aa4fe2194..cce3aedf2 100644 --- a/README.md +++ b/README.md @@ -363,8 +363,8 @@ best practice is to depend on `concurrent-ruby` and let users to decide if they ### Publishing the Gem -* Update `version.rb` -* Update the CHANGELOG with a section for the new version linking to its GitHub release notes +* Update `version.rb`. +* Update the CHANGELOG with a section for the new version linking to its GitHub release notes. * Add the new version to `docs-source/signpost.md`. Needs to be done only if there are visible changes in the documentation. * Commit (and push) the changes. * Use `bundle exec rake release` to release the gem.