Add guidance about the 'Update branch' button #1392
Merged
Conversation
This file contains 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.
Sometimes contributors click the "Update branch" button to merge in
maininto their PR, which is fine if there's a good reason, but if not, pings anyone subscribed to the PR, and uses up CI limited resources, which can cause delays on other PRs.Good reasons to click it include wanting to update an old PR, to make sure it still passes CI. Or if the PR is failing, and the some tests/config has been updated in
main.I occasionally need to tell contributors this in PRs. Let's add a section to the devguide so we have something handy to link to. Here's some proposed text, happy to change it.
Preview: https://cpython-devguide--1392.org.readthedocs.build/getting-started/pull-request-lifecycle/#update-branch-button