You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/devel/contribute.rst
+13-8Lines changed: 13 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -154,12 +154,17 @@ Work on an issue
154
154
----------------
155
155
156
156
In general, the Matplotlib project does not assign issues. Issues are
157
-
"assigned" or "claimed" by opening a PR; there is no other assignment
158
-
mechanism. If you have opened such a PR, please comment on the issue thread to
159
-
avoid duplication of work. Please check if there is an existing PR for the
160
-
issue you are addressing. If there is, try to work with the author by
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
161
165
submitting reviews of their code or commenting on the PR rather than opening
162
-
a new PR; duplicate PRs are subject to being closed. However, if the existing
166
+
a new PR; duplicate PRs are unnecessary concurrent work and thus are subject
167
+
to being closed. However, if the existing
163
168
PR is an outline, unlikely to work, or stalled, and the original author is
164
169
unresponsive, feel free to open a new PR referencing the old one.
165
170
@@ -183,7 +188,7 @@ our code consistent and mitigating the impact of changes.
183
188
*:ref:`pr-guidelines`
184
189
185
190
Code is contributed through pull requests, so we recommend that you start at
186
-
:ref:`how-to-contribute` If you get stuck, please reach out on the
191
+
:ref:`how-to-pull-request` If you get stuck, please reach out on the
187
192
:ref:`contributor_incubator`
188
193
189
194
.. _contribute_documentation:
@@ -236,7 +241,7 @@ Instructions and guidelines for contributing documentation are found in:
236
241
*:doc:`tag_guidelines`
237
242
238
243
Documentation is contributed through pull requests, so we recommend that you start
239
-
at:ref:`how-to-contribute`. If that feels intimidating, we encourage you to
244
+
at:ref:`how-to-pull-request`. If that feels intimidating, we encourage you to
240
245
`open an issue`_ describing what improvements you would make. If you get stuck,
241
246
please reach out on the:ref:`contributor_incubator`
242
247
@@ -260,7 +265,7 @@ please follow the :doc:`/project/citing` guidelines.
260
265
If you have developed an extension to Matplotlib, please consider adding it to our
261
266
`third party package<https://github.com/matplotlib/mpl-third-party>`_ list.