Clarify changelog guidance to prevent incorrect release notes#3380
Open
an-cor wants to merge 1 commit into
Open
Clarify changelog guidance to prevent incorrect release notes#3380an-cor wants to merge 1 commit into
an-cor wants to merge 1 commit into
Conversation
Signed-off-by: Angel Coronel <angelcoronel15@gmail.com>
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This PR updates the changelog contribution guidance in
CONTRIBUTING.mdto reduce the chance of stale or placeholder changelog entries producing incorrect release notes.Issue #2970 describes a release-process problem where release notes can become incorrect when
CHANGELOG.mdexists but is not kept up to date. The previous guidance instructed contributors to add changelog entries with dummy pull request information and update them later. This PR removes that wording and instead asks contributors to reference the real pull request and verify the entry before merge.Related Issue
Addresses part of #2970.
What Changed
Testing
This is a documentation-only change.
Validation performed:
No YAML validation was needed because this PR only changes
CONTRIBUTING.mdand does not modify any workflow files.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.