From 9acdc8c7391819352e089c706d88939048f08e48 Mon Sep 17 00:00:00 2001 From: Ruth Comer <10599679+rcomer@users.noreply.github.com> Date: Sat, 6 May 2023 14:51:32 +0100 Subject: [PATCH] DOC: add remote upstream --- doc/devel/development_setup.rst | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/doc/devel/development_setup.rst b/doc/devel/development_setup.rst index afcd63b3bf15..7ef8225e3606 100644 --- a/doc/devel/development_setup.rst +++ b/doc/devel/development_setup.rst @@ -59,13 +59,29 @@ should replace ```` with your GitHub username): This will place the sources in a directory :file:`matplotlib` below your -current working directory, set up the ``origin`` remote to point to your own -fork, and set up the ``upstream`` remote to point to the Matplotlib main -repository (see also `Managing remote repositories `__.) -Change into this directory before continuing:: +current working directory and set up the ``origin`` remote to point to your own +fork. Change into this directory before continuing:: cd matplotlib +Now set up the ``upstream`` remote to point to the Matplotlib main repository, +so that you can access the latest changes there (see also `Managing remote repositories +`__.): + +.. tab-set:: + + .. tab-item:: https + + .. code-block:: bash + + git remote add upstream https://github.com/matplotlib/matplotlib.git + + .. tab-item:: ssh + + .. code-block:: bash + + git remote add upstream git@github.com:matplotlib/matplotlib.git + .. note:: For more information on ``git`` and ``GitHub``, check the following resources.