Document preferred PR process for backports #2222
Merged
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.
Overview
This PR adds documentation to guide developers when submitting backport PRs to
release/YYMM
branches, addressing issue #XXX.Changes
Added a new "Backport PR Best Practices" section to the Release Management documentation (
Guide/src/dev_guide/contrib/release.md
) that clarifies:Clean cherry-picks are strongly preferred - Explicitly states that clean cherry-picks minimize reviewer effort and reduce the risk of introducing regressions.
Non-clean cherry-picks must be clearly indicated - Instructs developers to note in the PR description when a backport required conflict resolution or additional modifications, signaling to reviewers that extra care is needed during the review process.
Rationale
The new documentation helps streamline the backport process by:
The section is positioned immediately after the "Seeking Approval for Backport" section, making it a natural part of the backport workflow documentation.
Original prompt
Fixes #2175
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.