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..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 +* 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.