Skip to content

Commit 61d4e1d

Browse files
ofrobotsMylesBorins
authored andcommitted
doc: reorder section on updating PR branch
It makes more sense to provide instructions on how to update the PR branch before instructions on pushing the commit. PR-URL: #18355 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jon Moss <me@jonathanmoss.me>
1 parent 8a627b1 commit 61d4e1d

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

COLLABORATOR_GUIDE.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -596,20 +596,20 @@ Validate that the commit message is properly formatted using
596596
$ git rev-list upstream/master...HEAD | xargs core-validate-commit
597597
```
598598

599+
Optional: When landing your own commits, force push the amended commit to the
600+
branch you used to open the pull request. If your branch is called `bugfix`,
601+
then the command would be `git push --force-with-lease origin master:bugfix`.
602+
When the pull request is closed, this will cause the pull request to
603+
show the purple merged status rather than the red closed status that is
604+
usually used for pull requests that weren't merged.
605+
599606
Time to push it:
600607

601608
```text
602609
$ git push upstream master
603610
```
604-
* Optional: Force push the amended commit to the branch you used to
605-
open the pull request. If your branch is called `bugfix`, then the
606-
command would be `git push --force-with-lease origin master:bugfix`.
607-
When the pull request is closed, this will cause the pull request to
608-
show the purple merged status rather than the red closed status that is
609-
usually used for pull requests that weren't merged. Only do this when
610-
landing your own contributions.
611611

612-
* Close the pull request with a "Landed in `<commit hash>`" comment. If
612+
Close the pull request with a "Landed in `<commit hash>`" comment. If
613613
your pull request shows the purple merged status then you should still
614614
add the "Landed in <commit hash>..<commit hash>" comment if you added
615615
multiple commits.

0 commit comments

Comments
 (0)