Clarify expectations of change log entries #4828
Merged
Conversation
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
github-actions
bot
added
docs
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #4828 +/- ##
=========================================
Coverage ? 97.54%
=========================================
Files ? 1488
Lines ? 88999
Branches ? 4634
=========================================
Hits ? 86812
Misses ? 2187
Partials ? 0 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
✅ Tests 🎉 All green!❄️ No new flaky tests detected 🎯 Code Coverage 🔗 Commit SHA: 4f00c37 | Docs | Was this helpful? Give us feedback! |
p-datadog
force-pushed
the
changelog-instructions
branch
from
c5e9b61 to
4f00c37
Compare
y9v
approved these changes
Sep 17, 2025
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.
What does this PR do?
Expands the instructions for the change log entry in pull request template to state that the entries should be self-contained and readable by customers.
Motivation:
When we release, the person doing the releasing often has to edit change log entries, but this person has not made the relevant code changes and is often not familiar with all of the details.
The goal of this PR is to encourage higher quality change log entries in PRs, ideally such that they can be copied into release notes without further editing.
Change log entry
None
Additional Notes:
How to test the change?