Skip to content

Commit 9e1bfa8

Browse files
committed
Fixed rst spacing + review feedback.
1 parent af28f0b commit 9e1bfa8

File tree

1 file changed

+43
-35
lines changed

1 file changed

+43
-35
lines changed

doc/devel/contributing.rst

+43-35
Original file line numberDiff line numberDiff line change
@@ -12,44 +12,50 @@ is expected to abide by our
1212
The project is hosted on
1313
https://github.com/matplotlib/matplotlib
1414

15+
Get Connected
16+
=============
17+
1518
Do I really have something to contribute to Matplotlib?
1619
-------------------------------------------------------
17-
1,000% yes. There are so many ways to contribute to our community.
18-
19-
When in doubt, we recommend going together! Get connected with our community of active
20-
contributors, many of whom felt just like you when they started out and are happy to welcome
21-
you and support you as you get to know how we work, and where things are. Take a look at the
22-
next section to learn more.
2320

21+
100% yes. There are so many ways to contribute to our community.
2422

25-
Get Connected
26-
=============
23+
When in doubt, we recommend going together! Get connected with our community of
24+
active contributors, many of whom felt just like you when they started out and
25+
are happy to welcome you and support you as you get to know how we work, and
26+
where things are. Take a look at the next sections to learn more.
2727

2828
Contributor incubator
2929
---------------------
30-
The incubator is our non-public communication channel for new contributors. It is
31-
a private gitter room moderated by core Matplotlib developers where you can
32-
get guidance and support for your first few PRs. It's a place you can ask questions
33-
about anything: how to use git, github, how our PR review process works, technical questions
34-
about the code, what makes for good documentation or a blog post, how to get involved involved
35-
in community work, or get "pre-review" on your PR.
3630

37-
To join, please go to our public `gitter <https://gitter.im/matplotlib/matplotlib>`_ community
38-
channel, and ask to be added to '#incubator'. One of our core developers will see your message
39-
and will add you.
31+
The incubator is our non-public communication channel for new contributors. It
32+
is a private gitter room moderated by core Matplotlib developers where you can
33+
get guidance and support for your first few PRs. It's a place you can ask
34+
questions about anything: how to use git, github, how our PR review process
35+
works, technical questions about the code, what makes for good documentation
36+
or a blog post, how to get involved in community work, or get
37+
"pre-review" on your PR.
38+
39+
To join, please go to our public `gitter <https://gitter
40+
.im/matplotlib/matplotlib>`_ community channel, and ask to be added to
41+
'#incubator'. One of our core developers will see your message and will add you.
4042

4143
New Contributors meeting
4244
------------------------
43-
Once a month, we host a meeting to discuss topics that interest new contributors. Anyone can attend,
44-
present, or sit in and listen to the call. Among our attendees are fellow new contributors, as well
45-
as maintainers, and veteran contributors, who are keen to support onboarding of new folks and share
46-
their experience. You can find our community calendar link at the `Scientific Python website
47-
<https://scientific-python.org/calendars/>`_, and you can browse previous meeting notes on `github
48-
<https://github.com/matplotlib/ProjectManagement/tree/master/new_contributor_meeting>`_. We recommend
49-
joining the meeting to clarify any doubts, or lingering questions you might have, and to get to know a few
50-
of the people behind the GitHub handles 😉. You can reach out to @noatamir on `gitter
51-
<https://gitter.im/matplotlib/matplotlib>`_. For any clarifications or suggestions. We <3 feedback!
5245

46+
Once a month, we host a meeting to discuss topics that interest new
47+
contributors. Anyone can attend, present, or sit in and listen to the call.
48+
Among our attendees are fellow new contributors, as well as maintainers, and
49+
veteran contributors, who are keen to support onboarding of new folks and
50+
share their experience. You can find our community calendar link at the
51+
`Scientific Python website <https://scientific-python.org/calendars/>`_, and
52+
you can browse previous meeting notes on `github <https://github
53+
.com/matplotlib/ProjectManagement/tree/master/new_contributor_meeting>`_. We
54+
recommend joining the meeting to clarify any doubts, or lingering questions
55+
you might have, and to get to know a few of the people behind the GitHub
56+
handles 😉. You can reach out to @noatamir on `gitter <https://gitter
57+
.im/matplotlib/matplotlib>`_. For any clarifications or suggestions. We <3
58+
feedback!
5359

5460
.. _new_contributors:
5561

@@ -58,19 +64,20 @@ Issues for new contributors
5864

5965
While any contributions are welcome, we have marked some issues as
6066
particularly suited for new contributors by the label
61-
`good first issue <https://github.com/matplotlib/matplotlib/labels/good%20first%20issue>`_
62-
These are well documented issues, that do not require a deep understanding of
63-
the internals of Matplotlib. The issues may additionally be tagged with a
64-
difficulty. ``Difficulty: Easy`` is suited for people with little Python experience.
65-
``Difficulty: Medium`` and ``Difficulty: Hard`` require more programming experience.
66-
This could be for a variety of reasons, among them, though not necessarily all at
67-
the same time:
67+
`good first issue <https://github
68+
.com/matplotlib/matplotlib/labels/good%20first%20issue>`_ These are well
69+
documented issues, that do not require a deep understanding of the internals
70+
of Matplotlib. The issues may additionally be tagged with a difficulty.
71+
``Difficulty: Easy`` is suited for people with little Python experience.
72+
``Difficulty: Medium`` and ``Difficulty: Hard`` require more programming
73+
experience. This could be for a variety of reasons, among them, though not
74+
necessarily all at the same time:
6875

6976
- The issue is in areas of the code base which have more interdependencies,
7077
or legacy code.
7178
- It has less clearly defined tasks, which require some independent
72-
exploration, making suggestions, or follow-up discussions to clarify a good path
73-
to resolve the issue.
79+
exploration, making suggestions, or follow-up discussions to clarify a good
80+
path to resolve the issue.
7481
- It involves Python features such as decorators and context managers, which
7582
have subtleties due to our implementation decisions.
7683

@@ -610,3 +617,4 @@ example code you can load it into a file handle with::
610617

611618
import matplotlib.cbook as cbook
612619
fh = cbook.get_sample_data('mydata.dat')
620+

0 commit comments

Comments
 (0)