docs: explain BEGIN_COMMIT_OVERRIDE for PRs with several changes - #1810
Merged
Merged
Conversation
A squash merge keeps only the PR title, so release-please lists one changelog entry per PR. Document the commit override block for PRs that contain several changes that should be listed separately.
kikoso
marked this pull request as ready for review
October 1, 2026 17:03
Contributor
Code Coverage
|
dkhawk
approved these changes
Oct 1, 2026
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
3 participants
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.
Summary
Adds a rule to the "Pull requests" section of
AGENTS.md: when a PR contains several changes that belong in the changelog separately, add aBEGIN_COMMIT_OVERRIDE/END_COMMIT_OVERRIDEblock to the PR description, one Conventional Commit per line.A squash merge keeps only the PR title, so without the block release-please lists a single entry for the whole PR. #1809 is the first PR using it, with one
fix(data):line per bug.The rule also notes that the PR title must still be a valid Conventional Commit, and that each override line counts toward the version bump.