Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit decab75

Browse files
author
Felix
committed
changed use of git@ to https:// in dev docs since https works for everybody
1 parent e0415f9 commit decab75

File tree

3 files changed

+13
-11
lines changed

3 files changed

+13
-11
lines changed

doc/devel/contributing.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,11 @@ We use `Git <https://git-scm.com/>`_ for version control and
6767
You can check out the latest sources with the command (see
6868
:ref:`set-up-fork` for more details)::
6969

70-
git clone git@github.com:matplotlib/matplotlib.git
70+
git clone https://github.com:matplotlib/matplotlib.git
7171

72-
and navigate to the :file:`matplotlib` directory.
72+
and navigate to the :file:`matplotlib` directory. If you have the proper privileges,
73+
you can use ``git@`` instead of ``https://``, which works through the ssh protocol
74+
and might be easier to use if you are using 2-factor authentication.
7375

7476
To make sure the tests run locally you must build against the correct version
7577
of freetype. To configure the build system to fetch and build it either export
@@ -156,7 +158,7 @@ then submit a "pull request" (PR):
156158

157159
3. Clone this copy to your local disk::
158160

159-
$ git clone git@github.com:YourLogin/matplotlib.git
161+
$ git clone https://github.com:YourLogin/matplotlib.git
160162

161163
4. Create a branch to hold your changes::
162164

doc/devel/gitwash/development_workflow.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -208,10 +208,10 @@ collaborator:
208208

209209
Now all those people can do::
210210

211-
git clone git@githhub.com:your-user-name/matplotlib.git
211+
git clone https://gith hub.com:your-user-name/matplotlib.git
212212

213-
Remember that links starting with ``git@`` use the ssh protocol and are
214-
read-write; links starting with ``git://`` are read-only.
213+
Remember that links starting with ``https`` or ``git@`` are read-write, and that
214+
``git@`` uses the ssh protocol; links starting with ``git://`` are read-only.
215215

216216
Your collaborators can then commit directly into that repo with the
217217
usual::

doc/devel/gitwash/set_up_fork.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Overview
1313

1414
::
1515

16-
git clone git@github.com:your-user-name/matplotlib.git
16+
git clone https://github.com:your-user-name/matplotlib.git
1717
cd matplotlib
1818
git remote add upstream git://github.com/matplotlib/matplotlib.git
1919

@@ -24,7 +24,7 @@ Clone your fork
2424
---------------
2525

2626
#. Clone your fork to the local computer with ``git clone
27-
git@github.com:your-user-name/matplotlib.git``
27+
https://github.com:your-user-name/matplotlib.git``
2828
#. Investigate. Change directory to your new repo: ``cd matplotlib``. Then
2929
``git branch -a`` to show you all branches. You'll get something
3030
like:
@@ -55,7 +55,7 @@ Linking your repository to the upstream repo
5555
``upstream`` here is just the arbitrary name we're using to refer to the
5656
main `Matplotlib`_ repository at `Matplotlib github`_.
5757

58-
Note that we've used ``git://`` for the URL rather than ``git@``. The
58+
Note that we've used ``git://`` for the URL rather than ``https://`` or ``git@``. The
5959
``git://`` URL is read only. This means we that we can't accidentally
6060
(or deliberately) write to the upstream repo, and we are only going to
6161
use it to merge into our own code.
@@ -67,7 +67,7 @@ Just for your own satisfaction, show yourself that you now have a new
6767
6868
upstream git://github.com/matplotlib/matplotlib.git (fetch)
6969
upstream git://github.com/matplotlib/matplotlib.git (push)
70-
origin git@github.com:your-user-name/matplotlib.git (fetch)
71-
origin git@github.com:your-user-name/matplotlib.git (push)
70+
origin https://github.com:your-user-name/matplotlib.git (fetch)
71+
origin https://github.com:your-user-name/matplotlib.git (push)
7272
7373
.. include:: links.inc

0 commit comments

Comments
 (0)