| 13 | +============================== |
| 14 | + |
| 15 | +Matplotlib is hosted at https://github.com/matplotlib/matplotlib.git. If you |
| 16 | +plan on solving issues or submit pull requests to the main Matplotlib |
| 17 | +repository, you should first *fork* this repository by visiting |
| 18 | +https://github.com/matplotlib/matplotlib.git and clicking on the |
| 19 | +``Fork`` button on the top right of the page (see |
| 20 | +`the GitHub documentation <https://docs.github.com/get-started/quickstart/fork-a-repo>`__ for more details.) |
| 21 | + |
12 | 22 | Retrieve the latest version of the code
|
13 | 23 | =======================================
|
14 | 24 |
|
15 |
| -Matplotlib is hosted at https://github.com/matplotlib/matplotlib.git. |
16 |
| - |
17 |
| -You can retrieve the latest sources with the command (see |
18 |
| -`the GitHub documentation <https://docs.github.com/get-started/quickstart/fork-a-repo>`__ for more details):: |
| 25 | +Now that your fork of the repository lives under your GitHub username, you can |
| 26 | +retrieve the latest sources with one of the following commands (where your |
| 27 | +should replace ``<your-username>`` with your GitHub username): |
19 | 28 |
|
20 | 29 | .. tab-set::
|
21 | 30 |
|
22 | 31 | .. tab-item:: https
|
23 | 32 |
|
24 | 33 | .. code-block:: bash
|
25 | 34 |
|
26 |
| - git clone https://github.com/matplotlib/matplotlib.git |
| 35 | + git clone https://github.com/<your-username>/matplotlib.git |
27 | 36 |
|
28 | 37 | .. tab-item:: ssh
|
29 | 38 |
|
30 | 39 | .. code-block:: bash
|
31 | 40 |
|
32 |
| - git clone git@github.com:matplotlib/matplotlib.git |
| 41 | + git clone git@github.com:<your-username>/matplotlib.git |
33 | 42 |
|
34 | 43 | This requires you to setup an `SSH key`_ in advance, but saves you from
|
35 | 44 | typing your password at every connection.
|
36 | 45 |
|
37 | 46 | .. _SSH key: https://docs.github.com/en/authentication/connecting-to-github-with-ssh
|
38 | 47 |
|
| 48 | + |
39 | 49 | This will place the sources in a directory :file:`matplotlib` below your
|
40 |
| -current working directory, and set up the `upstream remote <https://docs.github.com/en/get-started/getting-started-with-git/managing-remote-repositories>`__ |
41 |
| -to point to the Matplotlib main repository. Change into this directory before |
42 |
| -continuing:: |
| 50 | +current working directory, set up the ``origin`` remote to point to your own |
| 51 | +fork, and set up the ``upstream`` remote to point to the Matplotlib main |
| 52 | +repository (see also `Managing remote repositories <https://docs.github.com/en/get-started/getting-started-with-git/managing-remote-repositories>`__.) |
| 53 | +Change into this directory before continuing:: |
43 | 54 |
|
44 | 55 | cd matplotlib
|
45 | 56 |
|
46 | 57 | .. note::
|
47 | 58 |
|
48 |
| - For more information on ``git`` and ``GitHub``, check the following resources. |
| 59 | + For more information on ``git`` and ``GitHub``, check the following resources. |
49 | 60 |
|
50 | 61 | * `Git documentation <https://git-scm.com/doc>`_
|
51 | 62 | * `Git-Contributing to a Project <https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project>`_
|
52 |
| - * `Introduction to GitHub <https://lab.github.com/githubtraining/introduction-to-github>`_ |
| 63 | + * `Introduction to GitHub <https://lab.github.com/githubtraining/introduction-to-github>`_ |
53 | 64 | * :ref:`using-git`
|
54 | 65 | * :ref:`git-resources`
|
55 | 66 | * `Installing git <https://git-scm.com/book/en/v2/Getting-Started-Installing-Git>`_
|
@@ -83,11 +94,6 @@ The simplest way to do this is to use either Python's virtual environment
|
83 | 94 | <file folder location>\Scripts\activate.bat # Windows cmd.exe
|
84 | 95 | <file folder location>\Scripts\Activate.ps1 # Windows PowerShell
|
85 | 96 |
|
86 |
| -Conda dev environment |
87 |
| ---------------------- |
88 |
| - |
89 |
| -After you have cloned the repo change into the matplotlib directory. |
90 |
| - |
91 | 97 | .. tab-item:: conda environment
|
92 | 98 |
|
93 | 99 | Create a new `conda`_ environment with ::
|
|
0 commit comments