8000 minor reshuffle of contributing · matplotlib/matplotlib@2db6983 · GitHub
[go: up one dir, main page]

Skip to content

Commit 2db6983

Browse files
committed
minor reshuffle of contributing
1 parent 380bba1 commit 2db6983

File tree

2 files changed

+114
-116
lines changed

2 files changed

+114
-116
lines changed

doc/devel/contribute.rst

Lines changed: 101 additions & 103 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,12 @@ existing issue and pull request discussions, and following the conversations
3030
during pull request reviews to get context. Or you can deep-dive into a subset
3131
of the code-base to understand what is going on.
3232

33-
There are a few typical new contributor profiles:
33+
Do I really have something to contribute to Matplotlib?
34+
-------------------------------------------------------
35+
36+
100% yes. There are so many ways to contribute to our community. Take a look at
37+
the next sections to learn more. There are a few typical new contributor
38+
profiles:
3439

3540
* **You are a Matplotlib user, and you see a bug, a potential improvement, or
3641
something that annoys you, and you can fix it.**
@@ -75,104 +80,10 @@ There are a few typical new contributor profiles:
7580
and gaining context on this area by reading the issues and pull requests
7681
touching these subjects is a reasonable approach.
7782

78-
.. _get_connected:
79-
80-
Get connected
81-
=============
82-
83-
Do I really have something to contribute to Matplotlib?
84-
-------------------------------------------------------
85-
86-
100% yes. There are so many ways to contribute to our community.
87-
88-
When in doubt, we recommend going together! Get connected with our community of
89-
active contributors, many of whom felt just like you when they started out and
90-
are happy to welcome you and support you as you get to know how we work, and
91-
where things are. Take a look at the next sections to learn more.
92-
93-
.. _contributor_incubator:
94-
95-
Contributor incubator
96-
---------------------
97-
98-
The incubator is our non-public communication channel for new contributors. It
99-
is a private gitter_ (chat) room moderated by core Matplotlib developers where
100-
you can get guidance and support for your first few PRs. It's a place where you
101-
can ask questions about anything: how to use git, GitHub, how our PR review
102-
process works, technical questions about the code, what makes for good
103-
documentation or a blog post, how to get involved in community work, or get a
104-
"pre-review" on your PR.
105-
106-
To join, please go to our public community_ channel, and ask to be added to
107-
``#incubator``. One of our core developers will see your message and will add you.
108-
109-
.. _gitter: https://gitter.im/matplotlib/matplotlib
110-
.. _community: https://gitter.im/matplotlib/community
111-
112-
New Contributors Meeting
113-
------------------------
114-
115-
Once a month, we host a meeting to discuss topics that interest new
116-
contributors. Anyone can attend, present, or sit in and listen to the call.
117-
Among our attendees are fellow new contributors, as well as maintainers, and
118-
veteran contributors, who are keen to support onboarding of new folks and
119-
share their experience. You can find our community calendar link at the
120-
`Scientific Python website <https://scientific-python.org/calendars/>`_, and
121-
you can browse previous meeting notes on `GitHub
122-
<https://github.com/matplotlib/ProjectManagement/tree/master/new_contributor_meeting>`_.
123-
We recommend joining the meeting to clarify any doubts, or lingering
124-
questions you might have, and to get to know a few of the people behind the
125-
GitHub handles 😉. You can reach out to us on gitter_ for any clarifications or
126-
suggestions. We ❤ feedback!
127-
128-
.. _new_contributors:
129-
130-
Good first issues
131-
-----------------
132-
133-
While any contributions are welcome, we have marked some issues as
134-
particularly suited for new contributors by the label `good first issue
135-
<https://github.com/matplotlib/matplotlib/labels/good%20first%20issue>`_. These
136-
are well documented issues, that do not require a deep understanding of the
137-
internals of Matplotlib. The issues may additionally be tagged with a
138-
difficulty. ``Difficulty: Easy`` is suited for people with little Python
139-
experience. ``Difficulty: Medium`` and ``Difficulty: Hard`` require more
140-
programming experience. This could be for a variety of reasons, among them,
141-
though not necessarily all at the same time:
142-
143-
- The issue is in areas of the code base which have more interdependencies,
144-
or legacy code.
145-
- It has less clearly defined tasks, which require some independent
146-
exploration, making suggestions, or follow-up discussions to clarify a good
147-
path to resolve the issue.
148-
- It involves Python features such as decorators and context managers, which
149-
have subtleties due to our implementation decisions.
150-
151-
.. _managing_issues_prs:
152-
153-
Work on an issue
154-
----------------
155-
156-
In general, the Matplotlib project does not assign issues. Issues are
157-
"assigned" or "claimed" by
158-
:ref:`proposing a solution via a pull request <how-to-pull-request>`.
159-
We ask pull request (PR) authors to
160-
`link to the issue in the PR
161-
<https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue>`_ because then Github adds corresponding links to the PR to the discussion and the sidebar on the linked issue page on GitHub.
162-
163-
Before starting to work on an issue, please check if there is already
164-
a linked PR. If there is, try to work with the author by
165-
submitting reviews of their code or commenting on the PR rather than opening
166-
a new PR; duplicate PRs are unnecessary concurrent work and thus are subject
167-
to being closed. However, if the existing
168-
PR is an outline, unlikely to work, or stalled, and the original author is
169-
unresponsive, feel free to open a new PR referencing the old one.
170-
171-
17283
.. _contribute_code:
17384

174-
Contribute code
175-
===============
85+
Code
86+
----
17687
You want to implement a feature or fix a bug or help with maintenance - much
17788
appreciated! Our library source code is found in
17889

@@ -193,8 +104,8 @@ Code is contributed through pull requests, so we recommend that you start at
193104

194105
.. _contribute_documentation:
195106

196-
Contribute documentation
197-
========================
107+
Documentation
108+
-------------
198109

199110
You as an end-user of Matplotlib can make a valuable contribution because you
200111
more clearly see the potential for improvement than a core developer. For example,
@@ -250,8 +161,8 @@ please reach out on the :ref:`contributor_incubator`
250161

251162
.. _other_ways_to_contribute:
252163

253-
Other ways to contribute
254-
========================
164+
Community
165+
---------
255166

256167
It also helps us if you spread the word: reference the project from your blog
257168
and articles or link to it from your website!
@@ -265,10 +176,97 @@ please follow the :doc:`/project/citing` guidelines.
265176
If you have developed an extension to Matplotlib, please consider adding it to our
266177
`third party package <https://github.com/matplotlib/mpl-third-party>`_ list.
267178

179+
180+
.. _get_connected:
181+
182+
Get connected
183+
=============
184+
When in doubt, we recommend going together! Get connected with our community of
185+
active contributors, many of whom felt just like you when they started out and
186+
are happy to welcome you and support you as you get to know how we work, and
187+
where things are.
188+
189+
.. _contributor_incubator:
190+
191+
Contributor incubator
192+
---------------------
193+
194+
The incubator is our non-public communication channel for new contributors. It
195+
is a private gitter_ (chat) room moderated by core Matplotlib developers where
196+
you can get guidance and support for your first few PRs. It's a place where you
197+
can ask questions about anything: how to use git, GitHub, how our PR review
198+
process works, technical questions about the code, what makes for good
199+
documentation or a blog post, how to get involved in community work, or get a
200+
"pre-review" on your PR.
201+
202+
To join, please go to our public community_ channel, and ask to be added to
203+
``#incubator``. One of our core developers will see your message and will add you.
204+
205+
.. _gitter: https://gitter.im/matplotlib/matplotlib
206+
.. _community: https://gitter.im/matplotlib/community
207+
208+
209+
.. _new_contributors:
210+
211+
New Contributors Meeting
212+
------------------------
213+
214+
Once a month, we host a meeting to discuss topics that interest new
215+
contributors. Anyone can attend, present, or sit in and listen to the call.
216+
Among our attendees are fellow new contributors, as well as maintainers, and
217+
veteran contributors, who are keen to support onboarding of new folks and
218+
share their experience. You can find our community calendar link at the
219+
`Scientific Python website <https://scientific-python.org/calendars/>`_, and
220+
you can browse previous meeting notes on `GitHub
221+
<https://github.com/matplotlib/ProjectManagement/tree/master/new_contributor_meeting>`_.
222+
We recommend joining the meeting to clarify any doubts, or lingering
223+
questions you might have, and to get to know a few of the people behind the
224+
GitHub handles 😉. You can reach out to us on gitter_ for any clarifications or
225+
suggestions. We ❤ feedback!
226+
227+
.. _managing_issues_prs:
228+
229+
Choose an issue
230+
===============
231+
232+
In general, the Matplotlib project does not assign issues. Issues are
233+
"assigned" or "claimed" by opening a PR; there is no other assignment
234+
mechanism. If you have opened such a PR, please comment on the issue thread to
235+
avoid duplication of work. Please check if there is an existing PR for the
236+
issue you are addressing. If there is, try to work with the author by
237+
submitting reviews of their code or commenting on the PR rather than opening
238+
a new PR; duplicate PRs are subject to being closed. However, if the existing
239+
PR is an outline, unlikely to work, or stalled, and the original author is
240+
unresponsive, feel free to open a new PR referencing the old one.
241+
242+
.. _good_first_issues:
243+
244+
Good first issues
245+
-----------------
246+
247+
While any contributions are welcome, we have marked some issues as
248+
particularly suited for new contributors by the label `good first issue
249+
<https://github.com/matplotlib/matplotlib/labels/good%20first%20issue>`_. These
250+
are well documented issues, that do not require a deep understanding of the
251+
internals of Matplotlib. The issues may additionally be tagged with a
252+
difficulty. ``Difficulty: Easy`` is suited for people with little Python
253+
experience. ``Difficulty: Medium`` and ``Difficulty: Hard`` require more
254+
programming experience. This could be for a variety of reasons, among them,
255+
though not necessarily all at the same time:
256+
257+
- The issue is in areas of the code base which have more interdependencies,
258+
or legacy code.
259+
- It has less clearly defined tasks, which require some independent
260+
exploration, making suggestions, or follow-up discussions to clarify a good
261+
path to resolve the issue.
262+
- It involves Python features such as decorators and context managers, which
263+
have subtleties due to our implementation decisions.
264+
265+
268266
.. _how-to-pull-request:
269267

270-
How to contribute via pull request
271-
==================================
268+
Start a pull request
269+
====================
272270

273271
The preferred way to contribute to Matplotlib is to fork the `main
274272
repository <https://github.com/matplotlib/matplotlib/>`__ on GitHub,

doc/devel/index.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,14 @@ implementing new features...
6262

6363
New contributors
6464
================
65+
66+
If you are new to contributing, we recommend that you first read our
67+
:ref:`contributing guide<contributing>`. If you are contributing code or
68+
documentation, please follow our guides for setting up and managing a
69+
:ref:`development environment and workflow<development_environment>`.
70+
For code, documentation, or triage, please follow the corresponding
71+
:ref:`contribution guidelines <contribution_guideline>`.
72+
6573
.. toctree::
6674
:hidden:
6775

@@ -77,11 +85,9 @@ New contributors
7785

7886
:octicon:`question;1em;sd-text-info` :ref:`Where should I ask questions? <get_connected>`
7987

80-
:octicon:`issue-opened;1em;sd-text-info` :ref:`What are "good-first-issues"? <new_contributors>`
88+
:octicon:`git-pull-request;1em;sd-text-info` :ref:`How do I choose an issue? <managing_issues_prs>`
8189

82-
:octicon:`git-pull-request;1em;sd-text-info` :ref:`How do I claim an issue? <managing_issues_prs>`
83-
84-
:octicon:`codespaces;1em;sd-text-info` :ref:`How do I start a pull request? <how-to-pull-request>`
90+
:octicon:`codespaces;1em;sd-text-info` :ref:`How do I start a pull request? <how-to-contribute>`
8591

8692
.. grid-item::
8793

@@ -94,29 +100,23 @@ New contributors
94100
:link-type: ref
95101
:shadow: none
96102

97-
:octicon:`code;1em;sd-text-info` Contribute code
103+
:octicon:`code;1em;sd-text-info` Code
98104

99105
.. grid-item-card::
100106
:link: contribute_documentation
101107
:link-type: ref
102108
:shadow: none
103109

104-
:octicon:`note;1em;sd-text-info` Write documentation
110+
:octicon:`note;1em;sd-text-info` Documentation
105111

106112
.. grid-item-card::
107113
:link: other_ways_to_contribute
108114
:link-type: ref
109115
:shadow: none
110116

111-
:octicon:`paper-airplane;1em;sd-text-info` Other ways to contribute
117+
:octicon:`paper-airplane;1em;sd-text-info` Community
112118

113119

114-
If you are new to contributing, we recommend that you first read our
115-
:ref:`contributing guide<contributing>`. If you are contributing code or
116-
documentation, please follow our guides for setting up and managing a
117-
:ref:`development environment and workflow<development_environment>`.
118-
For code, documentation, or triage, please follow the corresponding
119-
:ref:`contribution guidelines <contribution_guideline>`.
120120

121121

122122
.. _development_environment:

0 commit comments

Comments
 (0)
0