Transition to new process for updating changelogs #5111
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Explanation
Currently, we ask that when contributors submit a pull request, they fill out a Changelog section in the description which lists all of the consumer-facing changes they've made. This section is ultimately used when creating a new release to assist with populating
CHANGELOG.md
files.However, this process is difficult to follow in practice because it forces release authors to do work on behalf of other engineers. The people that know how to describe changes best are those that made the change, so they should be reponsible for updating changelogs.
With this commit, we now direct contributors to update changelog files directly as they make changes instead of placing them in the Changelog section of the PR description (which no longer exists). This commit adds documentation on how to do this effectively (much of which is now in the
contributor-docs
repo).References
Progresses #4385.
Checklist