DOC: add remote upstream #25828
DOC: add remote upstream #25828
Conversation
There was a problem hiding this comment.
Using 'remote' as shorthand for remote repository is a holdover from previous version so won't block, but wondering if it's worth it to add a sentence clarifying what a remote repository is and that the names for things are conventions. I know, we're not aiming to provide a "how to git" tutorial but I think this can be done very cleanly.
|
"remote" is git's term and part of the command you need to use. We have the link to GitHub's Managing remote repositories, which gives a bit more detail to what these things are, and I think the fact that you pass the GitHub url makes it fairly intuitive what you are linking to. So I'm not sure what else this needs. I do in general have a preference for brevity though, which I'm aware is just a preference. So it's possible I'm just not seeing what you're seeing! |
| fork, and set up the ``upstream`` remote to point to the Matplotlib main | ||
| repository (see also `Managing remote repositories <https://docs.github.com/en/get-started/getting-started-with-git/managing-remote-repositories>`__.) | ||
| Change into this directory before continuing:: | ||
| current working directory and set up the ``origin`` remote to point to your own |
There was a problem hiding this comment.
| current working directory and set up the ``origin`` remote to point to your own | |
| current working directory and set up a remote repository ``origin`` pointing to your own |
Is this clearer? If so, same wording should be applied to upstream
There was a problem hiding this comment.
I really really really like this minor change - it addresses my concerns by explaining what the words are. Can I open a follow on PR to make this change?
|
I think the wording is fine as it is. |
building off of matplotlib#25828 and @timhoffm's comment, mostly reworded/moved things (very little if any change in length) to try and make it more explicit that in this context origin and upstream are aliases for remote repositories.
building off of matplotlib#25828 and @timhoffm's comment, mostly reworded/moved things (very little if any change in length) to try and make it more explicit that in this context origin and upstream are aliases for remote repositories.
building off of matplotlib#25828 and @timhoffm's comment, mostly reworded/moved things (very little if any change in length) to try and make it more explicit that in this context origin and upstream are aliases for remote repositories. Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
PR summary
The dev guide currently suggests that cloning your fork will automatically add the upstream remote, but I think you have to add it manually.
PR checklist