-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
doc : rebase #2742
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc : rebase #2742
Conversation
I have never liked To be fair, my use of 'github' for the user's repository is just as confusing. |
FWIW numpy have also documented a similar thing: http://docs.scipy.org/doc/numpy/dev/gitwash/development_workflow.html#rebasing-on-master |
@pelson I (humbly) like my version better because I include the output of the middle steps, but I will include a link. |
don't merge this, I am going to go through and update the rest of the git documentation as well (git is changing under us a bit in the way it deals with push). I also plan to change |
I am also going to remove the text about emailing diffs to the mailing list to bring our documentation into line with our practice (which seems to be to make PRs and then do the review in the PR). |
The first step is to make sure that your local copy of the upstream repository is | ||
up-to-date:: | ||
|
||
$ git fetch upstream |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it pertinent a git checkout master
before the git fetch upstream
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, fetch only copies commits it does not merge them into your branches. I am deeply suspicious of pull
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So am I: pull merges automatically, which is rarely what you want.
I didn't notice before, you are adding this text to Actually that link development_workflow is the reference for all of us newcomers and git virgins. Just a little extra, the |
@tacaswell
|
Sorry, this issue should have been tagged as needs revision, thanks for poking me on this. |
punted |
considered bad form, but in this case it is very useful. | ||
|
||
The following example assumes that the remote of _your_ github | ||
repository is called `github` and the remote of the official |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would rename github to origin: it is more standard.
I'll do a PR against your PR. |
@@ -135,6 +135,149 @@ C/C++ extensions | |||
docstrings, and the Numpydoc format is well understood in the | |||
scientific Python community. | |||
|
|||
Rebasing a Pull Request |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should probably add the acronym (PR). It isn't defined anywhere, and is github jargon.
I think the only outstanding issues is my use of |
|
||
$ git push --force github | ||
|
||
which will _replace_ all of the commits under your branch on github |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
GitHub
I think you'll have to rebase onto master :) |
- this will likely create an annoying conflict, yay
35356bc
to
2ffb590
Compare
Decided to try out the 'retarget branch' functionality. |
@QuLogic Is that better wording? |
Looks reasonable. |
Thanks! |
🎉 Excited to get this in after so long! |
closes #2733
My writing probably needs a lot of editing.