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 0724d39

Browse filesBrowse files
authored
Merge pull request #19344 from ianhi/docs
Improvements to Docs for new contributors
2 parents 3d349f2 + 7965576 commit 0724d39
Copy full SHA for 0724d39

File tree

Expand file treeCollapse file tree

2 files changed

+43
-29
lines changed
Filter options
Expand file treeCollapse file tree

2 files changed

+43
-29
lines changed

‎doc/devel/contributing.rst

Copy file name to clipboardExpand all lines: doc/devel/contributing.rst
+28-29Lines changed: 28 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,20 @@ about the code, what makes for good documentation or a blog post, how to get inv
2525
in community work, or get "pre-review" on your PR.
2626

2727

28+
.. _new_contributors:
29+
30+
Issues for New Contributors
31+
---------------------------
32+
33+
While any contributions are welcome, we have marked some issues as
34+
particularly suited for new contributors by the label
35+
`good first issue <https://github.com/matplotlib/matplotlib/labels/good%20first%20issue>`_
36+
These are well documented issues, that do not require a deep understanding of
37+
the internals of Matplotlib. The issues may additionally be tagged with a
38+
difficulty. ``Difficulty: Easy`` is suited for people with little Python experience.
39+
``Difficulty: Medium`` and ``Difficulty: Hard`` are not trivial to solve and
40+
require more thought and programming experience.
41+
2842
.. _submitting-a-bug-report:
2943

3044
Submitting a bug report
@@ -53,10 +67,10 @@ If you are reporting a bug, please do your best to include the following:
5367

5468
>>> import matplotlib
5569
>>> matplotlib.__version__
56-
'1.5.3'
70+
'3.4.1'
5771
>>> import platform
5872
>>> platform.python_version()
59-
'2.7.12'
73+
'3.9.2'
6074

6175
We have preloaded the issue creation page with a Markdown template that you can
6276
use to organize this information.
@@ -88,9 +102,6 @@ The preferred way to contribute to Matplotlib is to fork the `main
88102
repository <https://github.com/matplotlib/matplotlib/>`__ on GitHub,
89103
then submit a "pull request" (PR).
90104

91-
The best practices for using GitHub to make PRs to Matplotlib are
92-
documented in the :ref:`development-workflow` section.
93-
94105
A brief overview is:
95106

96107
1. `Create an account <https://github.com/join>`_ on GitHub if you do not
@@ -102,34 +113,36 @@ A brief overview is:
102113

103114
3. Clone this copy to your local disk::
104115

105-
$ git clone https://github.com/YourLogin/matplotlib.git
116+
git clone https://github.com/<YOUR GITHUB USERNAME>/matplotlib.git
106117

107-
4. Create a branch to hold your changes::
118+
4. Enter the directory and install the local version of Matplotlib.
119+
See ref`<installing_for_devs>` for instructions
108120

109-
$ git checkout -b my-feature origin/master
121+
5. Create a branch to hold your changes::
122+
123+
git checkout -b my-feature origin/master
110124

111125
and start making changes. Never work in the ``master`` branch!
112126

113-
5. Work on this copy, on your computer, using Git to do the version control.
127+
6. Work on this copy, on your computer, using Git to do the version control.
114128
When you're done editing e.g., ``lib/matplotlib/collections.py``, do::
115129

116-
$ git add lib/matplotlib/collections.py
117-
$ git commit
130+
git add lib/matplotlib/collections.py
131+
git commit
118132

119133
to record your changes in Git, then push them to GitHub with::
120134

121-
$ git push -u origin my-feature
135+
git push -u origin my-feature
122136

123137
Finally, go to the web page of your fork of the Matplotlib repo, and click
124-
'Pull request' to send your changes to the maintainers for review. You may
125-
want to consider sending an email to the mailing list for more visibility.
138+
'Pull request' to send your changes to the maintainers for review.
126139

127140
.. seealso::
128141

129142
* `Git documentation <https://git-scm.com/documentation>`_
130143
* `Git-Contributing to a Project <https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project>`_
131144
* `Introduction to GitHub <https://lab.github.com/githubtraining/introduction-to-github>`_
132-
* :ref:`development-workflow`
145+
* :ref:`development-workflow` for best practices for Matplotlib
133146
* :ref:`using-git`
134147

135148
Contributing pull requests
@@ -216,20 +229,6 @@ tools:
216229

217230

218231

219-
.. _new_contributors:
220-
221-
Issues for New Contributors
222-
---------------------------
223-
224-
New contributors should look for the following tags when looking for issues.
225-
We strongly recommend that new contributors tackle issues labeled
226-
`good first issue <https://github.com/matplotlib/matplotlib/labels/good%20first%20issue>`_
227-
as they are easy, well documented issues, that do not require an understanding of
228-
the different submodules of Matplotlib.
229-
This helps the contributor become familiar with the contribution
230-
workflow, and for the core devs to become acquainted with the contributor;
231-
besides which, we frequently underestimate how easy an issue is to solve!
232-
233232

234233
.. _contributing_documentation:
235234

‎doc/devel/index.rst

Copy file name to clipboardExpand all lines: doc/devel/index.rst
+15Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,21 @@
44
The Matplotlib Developers' Guide
55
################################
66

7+
Thank you for your interest in helping to improve Matplotlib! There are various
8+
ways to contribute to Matplotlib. All of them are super valuable but don't necessarily
9+
require writing code at all. For example:
10+
11+
- contributing to the documentation
12+
- opening new issues for bugs
13+
- requesting new features
14+
- asking for clarification on things you find unclear
15+
- fixing bugs
16+
17+
If you have any questions on the
18+
process or how to fix something feel free to ask on `gitter
19+
<https://gitter.im/matplotlib/matplotlib>`_ for short questions and on
20+
`discourse <discourse.matplotlib.org>`_ for longer questions.
21+
722
.. raw:: html
823

924
<div style="margin: 2em 0;">

0 commit comments

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