Skip to content

Clarify changelog guidance to prevent incorrect release notes#3380

Open
an-cor wants to merge 1 commit into
opensearch-project:mainfrom
an-cor:fix-issue-2970
Open

Clarify changelog guidance to prevent incorrect release notes#3380
an-cor wants to merge 1 commit into
opensearch-project:mainfrom
an-cor:fix-issue-2970

Conversation

@an-cor

@an-cor an-cor commented Jun 23, 2026

Copy link
Copy Markdown

Description

This PR updates the changelog contribution guidance in CONTRIBUTING.md to 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.md exists 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

  • Added a note that release notes are generated from the changelog, so stale or inaccurate entries can result in incorrect release notes.
  • Removed guidance that encouraged dummy pull request information.
  • Clarified that contributors should verify the changelog entry references the correct PR and accurately describes the change before merge.

Testing

This is a documentation-only change.

Validation performed:

git diff --check HEAD~1 HEAD

No YAML validation was needed because this PR only changes CONTRIBUTING.md and 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.

Signed-off-by: Angel Coronel <angelcoronel15@gmail.com>
@github-actions

Copy link
Copy Markdown

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🧪 No relevant tests
🔒 No security concerns identified
✅ No TODO sections
🔀 No multiple PR themes
⚡ No major issues detected

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant