Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 270fdde

Browse filesBrowse files
committed
Reorganizing content
1 parent e592e7a commit 270fdde
Copy full SHA for 270fdde

File tree

Expand file treeCollapse file tree

2 files changed

+27
-21
lines changed
Filter options
Expand file treeCollapse file tree

2 files changed

+27
-21
lines changed

‎doc/devel/development_setup.rst

Copy file name to clipboardExpand all lines: doc/devel/development_setup.rst
+22-16Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,47 +9,58 @@ To set up Matplotlib for development follow these steps:
99
.. contents::
1010
:local:
1111

12+
Fork the Matplotlib repository
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+
1222
Retrieve the latest version of the code
1323
=======================================
1424

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):
1928

2029
.. tab-set::
2130

2231
.. tab-item:: https
2332

2433
.. code-block:: bash
2534
26-
git clone https://github.com/matplotlib/matplotlib.git
35+
git clone https://github.com/<your-username>/matplotlib.git
2736
2837
.. tab-item:: ssh
2938

3039
.. code-block:: bash
3140
32-
git clone git@github.com:matplotlib/matplotlib.git
41+
git clone git@github.com:<your-username>/matplotlib.git
3342
3443
This requires you to setup an `SSH key`_ in advance, but saves you from
3544
typing your password at every connection.
3645

3746
.. _SSH key: https://docs.github.com/en/authentication/connecting-to-github-with-ssh
3847

48+
3949
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::
4354

4455
cd matplotlib
4556

4657
.. note::
4758

48-
For more information on ``git`` and ``GitHub``, check the following resources.
59+
For more information on ``git`` and ``GitHub``, check the following resources.
4960

5061
* `Git documentation <https://git-scm.com/doc>`_
5162
* `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>`_
5364
* :ref:`using-git`
5465
* :ref:`git-resources`
5566
* `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
8394
<file folder location>\Scripts\activate.bat # Windows cmd.exe
8495
<file folder location>\Scripts\Activate.ps1 # Windows PowerShell
8596

86-
Conda dev environment
87-
---------------------
88-
89-
After you have cloned the repo change into the matplotlib directory.
90-
9197
.. tab-item:: conda environment
9298

9399
Create a new `conda`_ environment with ::

‎doc/devel/development_workflow.rst

Copy file name to clipboardExpand all lines: doc/devel/development_workflow.rst
+5-5Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ why you did it, we recommend the following:
2121
``bugfix-for-issue-14`` or ``refactor-database-code``.
2222
* If you get stuck, reach out on Gitter or
2323
`discourse <https://discourse.matplotlib.org>`__.
24-
* When your ready or need feedback on your code, open a pull-request so that the
24+
* When your ready or need feedback on your code, open a pull request so that the
2525
Matplotlib developers can give feedback and eventually include your suggested
2626
code into the ``main`` branch.
2727

@@ -35,10 +35,10 @@ why you did it, we recommend the following:
3535

3636
.. _update-mirror-main:
3737

38-
Update the mirror of main
39-
=========================
38+
Update the ``main`` branch
39+
==========================
4040

41-
First make sure you have done :ref:`linking-to-upstream`.
41+
First make sure you have followed :ref:`installing_for_devs`.
4242

4343
From time to time you should fetch the upstream changes from github::
4444

@@ -65,7 +65,7 @@ what the changes in the branch are for. For example ``add-ability-to-fly``, or
6565

6666
::
6767

68-
# Update the mirror of main
68+
# Update the main branch
6969
git fetch upstream
7070
# Make new feature branch starting at current main
7171
git branch my-new-feature upstream/main

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.