kookie
/
nomicon
1
0
Fork 0
Code Issues Projects Releases 1 Activity

Merge #175352: CONTRIBUTING.md: simplify rebasing instructions

Browse Source
main
piegames 2 years ago committed by GitHub
parent 862c5cd0e0 d2990717f1
commit f4e2a3c698
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 13 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 27
      CONTRIBUTING.md

27
CONTRIBUTING.md
Unescape View File

@ -62,25 +62,26 @@ many CODEOWNERS will be inadvertently requested for review. To achieve this,
rebasing should not be performed directly on the target branch, but on the merge rebasing should not be performed directly on the target branch, but on the merge
base between the current and target branch. base between the current and target branch.
In the following example, we see a rebase from `master` onto the merge base In the following example, we assume that the current branch, called `feature`,
between `master` and `staging`, so that a change can eventually be retargeted to is based on `master`, and we rebase it onto the merge base between
`staging`. The example uses `upstream` as the remote for `NixOS/nixpkgs.git` `master` and `staging` so that the PR can eventually be retargeted to
while the `origin` remote is used for the remote you are pushing to. `staging` without causing a mess. The example uses `upstream` as the remote for `NixOS/nixpkgs.git`
while `origin` is the remote you are pushing to.
```console ```console
# Find the common base between two branches # Rebase your commits onto the common merge base
common=$(git merge-base upstream/master upstream/staging) git rebase --onto upstream/staging... upstream/master
# Find the common base between your feature branch and master
commits=$(git merge-base $(git branch --show-current) upstream/master)
# Rebase all commits onto the common base
git rebase --onto=$common $commits
# Force push your changes # Force push your changes
git push origin $(git branch --show-current) --force-with-lease git push origin feature --force-with-lease
``` ```
The syntax `upstream/staging...` is equivalent to `upstream/staging...HEAD` and
stands for the merge base between `upstream/staging` and `HEAD` (hence between
`upstream/staging` and `upstream/master`).
Then change the base branch in the GitHub PR using the *Edit* button in the upper Then change the base branch in the GitHub PR using the *Edit* button in the upper
right corner, and switch from `master` to `staging`. After the PR has been right corner, and switch from `master` to `staging`. *After* the PR has been
retargeted it might be necessary to do a final rebase onto the target branch, to retargeted it might be necessary to do a final rebase onto the target branch, to
resolve any outstanding merge conflicts. resolve any outstanding merge conflicts.
@ -90,7 +91,7 @@ git rebase upstream/staging
# Review and fixup possible conflicts # Review and fixup possible conflicts
git status git status
# Force push your changes # Force push your changes
git push origin $(git branch --show-current) --force-with-lease git push origin feature --force-with-lease
``` ```
## Backporting changes ## Backporting changes

Write Preview
Loading…
Cancel
Save