Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fixed rst spacing + review feedback.
  • Loading branch information
noatamir committed Aug 24, 2022
commit 9e1bfa8599287f03ecb815b71acd9cd68c917dc7
78 changes: 43 additions & 35 deletions doc/devel/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,44 +12,50 @@ is expected to abide by our
The project is hosted on
https://github.com/matplotlib/matplotlib

Get Connected
=============

Do I really have something to contribute to Matplotlib?
-------------------------------------------------------
1,000% yes. There are so many ways to contribute to our community.

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

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

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

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

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

To join, please go to our public `gitter <https://gitter
.im/matplotlib/matplotlib>`_ community channel, and ask to be added to
'#incubator'. One of our core developers will see your message and will add you.
Comment thread
QuLogic marked this conversation as resolved.
Outdated

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

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

.. _new_contributors:

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

While any contributions are welcome, we have marked some issues as
particularly suited for new contributors by the label
`good first issue <https://github.com/matplotlib/matplotlib/labels/good%20first%20issue>`_
These are well documented issues, that do not require a deep understanding of
the internals of Matplotlib. The issues may additionally be tagged with a
difficulty. ``Difficulty: Easy`` is suited for people with little Python experience.
``Difficulty: Medium`` and ``Difficulty: Hard`` require more programming experience.
This could be for a variety of reasons, among them, though not necessarily all at
the same time:
`good first issue <https://github
.com/matplotlib/matplotlib/labels/good%20first%20issue>`_ These are well
documented issues, that do not require a deep understanding of the internals
of Matplotlib. The issues may additionally be tagged with a difficulty.
``Difficulty: Easy`` is suited for people with little Python experience.
``Difficulty: Medium`` and ``Difficulty: Hard`` require more programming
experience. This could be for a variety of reasons, among them, though not
necessarily all at the same time:
Comment thread
QuLogic marked this conversation as resolved.
Outdated

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

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

import matplotlib.cbook as cbook
fh = cbook.get_sample_data('mydata.dat')