Skip to content

Commit cdb9082

Browse files
authored
Document that release notes are generated from pull requests (#1120)
1 parent 25c8cd1 commit cdb9082

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

‎.github/CONTRIBUTING.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,9 +104,9 @@ git rebase upstream/master
104104
git push origin my-feature-branch -f
105105
```
106106

107-
#### Update CHANGELOG
107+
#### Release Notes
108108

109-
Update the [CHANGELOG](../CHANGELOG.md) with a description of what you have changed.
109+
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.
110110

111111
#### Check on Your Pull Request
112112

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -363,8 +363,8 @@ best practice is to depend on `concurrent-ruby` and let users to decide if they
363363

364364
### Publishing the Gem
365365

366-
* Update `version.rb`
367-
* Update the CHANGELOG
366+
* Update `version.rb`.
367+
* Update the CHANGELOG with a section for the new version linking to its GitHub release notes.
368368
* Add the new version to `docs-source/signpost.md`. Needs to be done only if there are visible changes in the documentation.
369369
* Commit (and push) the changes.
370370
* Use `bundle exec rake release` to release the gem.

0 commit comments

Comments
 (0)