doc/source/gitwash/set_up_fork.rst
.. _set-up-fork:
First you follow the instructions for :ref:forking.
::
git clone [email protected]:your-user-name/scikit-image.git cd scikit-image git remote add upstream https://github.com/scikit-image/scikit-image.git
#. Clone your fork to the local computer with git clone [email protected]:your-user-name/scikit-image.git
#. Investigate. Change directory to your new repo: cd scikit-image. Then
git branch -a to show you all branches. You'll get something
like::
* main
remotes/origin/main
This tells you that you are currently on the main branch, and
that you also have a remote connection to origin/main.
What remote repository is remote/origin? Try git remote -v to
see the URLs for the remote. They will point to your github fork.
Now you want to connect to the upstream scikit-image github_ repository, so
you can merge in changes from trunk.
.. _linking-to-upstream:
::
cd scikit-image git remote add upstream https://github.com/scikit-image/scikit-image.git
upstream here is just the arbitrary name we're using to refer to the
main scikit-image_ repository at scikit-image github_.
Note that we've used https:// for the URL rather than git@. The
https:// URL is read only. This means we that we can't accidentally
(or deliberately) write to the upstream repo, and we are only going to
use it to merge into our own code.
Just for your own satisfaction, show yourself that you now have a new
'remote', with git remote -v show, giving you something like::
upstream https://github.com/scikit-image/scikit-image.git (fetch) upstream https://github.com/scikit-image/scikit-image.git (push) origin [email protected]:your-user-name/scikit-image.git (fetch) origin [email protected]:your-user-name/scikit-image.git (push)
.. include:: links.inc