[backport checklist] Add when/why guidance to checklist comment - #20605
Draft
mrodm wants to merge 3 commits into
Draft
[backport checklist] Add when/why guidance to checklist comment#20605mrodm wants to merge 3 commits into
mrodm wants to merge 3 commits into
Conversation
Add a sentence to the backport checklist comment explaining the core
decision rule ("backport if it fixes existing behavior; leave new
behavior on main") and linking to the Package Backports wiki page for
full context. Developers seeing the checklist for the first time now
have enough information to decide whether to tick a branch without
needing to search for documentation separately.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
5 tasks
💚 Build Succeeded
History
cc @mrodm |
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.
Proposed commit message
Add a sentence to the backport checklist comment explaining the core
decision rule ("backport if it fixes existing behavior; leave new
behavior on main") and linking to the Package Backports wiki page for
full context. Developers seeing the checklist for the first time now
have enough information to decide whether to tick a branch without
needing to search for documentation separately.
Author's Checklist
How to test this PR locally
Run the backports test suite:
go test ./dev/backports/...To eyeball the rendered output, create a minimal artifact file and run
mage renderBackportChecklist:Check that the new guidance sentence and wiki link appear between the intro line and the first package section.
Example of the resulting checklist comment (from mrodm/integrations#78):
Related issues