Skip to content

Commit dffff23

Browse files
committed
DOC: Clarify draft PR and move from ways to contribute to PR guidelines
Closes #30436.
1 parent 0394f4e commit dffff23

File tree

3 files changed

+27
-13
lines changed

3 files changed

+27
-13
lines changed

doc/devel/contribute.rst

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ Ways to contribute
2929
* **You are a Matplotlib user, and you see a bug, a potential improvement, or
3030
something that annoys you, and you can fix it.**
3131

32-
You can search our issue tracker for an existing issue that describes your problem or
32+
You can search our `issue tracker <https://github.com/matplotlib/matplotlib/issues>`__
33+
for an existing issue that describes your problem or
3334
open a new issue to inform us of the problem you observed and discuss the best approach
3435
to fix it. If your contributions would not be captured on GitHub (social media,
3536
communication, educational content), you can also reach out to us on gitter_,
@@ -42,14 +43,11 @@ Ways to contribute
4243

4344
Awesome — you have a focus on a specific application and domain and can
4445
start there. In this case, maintainers can help you figure out the best
45-
implementation; open an issue or pull request with a starting point, and we'll
46-
be happy to discuss technical approaches.
46+
implementation; `open an issue <https://github.com/matplotlib/matplotlib/issues/new/choose>`__
47+
in our issue tracker, and we'll be happy to discuss technical approaches.
4748

48-
If you prefer, you can use the `GitHub functionality for "draft" pull requests
49-
<https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request#converting-a-pull-request-to-a-draft>`__
50-
and request early feedback on whatever you are working on, but you should be
51-
aware that maintainers may not review your contribution unless it has the
52-
"Ready to review" state on GitHub.
49+
If you can implement the solution yourself, even better! Consider contributing
50+
the change as a :ref:`pull request <how-to-pull-request>` right away.
5351

5452
* **You are new to Matplotlib, both as a user and contributor, and want to start
5553
contributing but have yet to develop a particular interest.**
@@ -287,7 +285,7 @@ guide you through each step:
287285
4. Check existing pull requests (e.g., :ghpull:`28476`) and filter by the issue number to make sure the issue is not in progress:
288286

289287
* If the issue has a pull request (is in progress), tag the user working on the issue, and ask to collaborate (optional).
290-
* If a pull request does not exist, create a `draft pull request <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests#draft-pull-requests>`_ and follow the `pull request guidelines <https://matplotlib.org/devdocs/devel/pr_guide.html>`_.
288+
* If a pull request does not exist, create a :ref:`draft pull request <draft-pr>`.
291289
5. Please familiarize yourself with the pull request template (see below),
292290
and ensure you understand/are able to complete the template when you open your pull request.
293291
Additional information can be found in the `pull request guidelines <https://matplotlib.org/devdocs/devel/pr_guide.html>`_.

doc/devel/development_workflow.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -179,9 +179,9 @@ Enter a title for the set of changes with some explanation of what you've done.
179179
Mention anything you'd like particular attention for - such as a
180180
complicated change or some code you are not happy with.
181181

182-
If you don't think your request is ready to be merged, just say so in your pull
183-
request message and use the "Draft PR" feature of GitHub. This is a good way of
184-
getting some preliminary code review.
182+
If you don't think your request is ready to be merged, make a
183+
:ref:`draft pull request <draft-pr>` and state what aspects you want to have
184+
feedback on. This is a good way of getting some preliminary code review.
185185

186186
For more guidance on the mechanics of making a pull request, see GitHub's
187187
`pull request tutorial <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork>`_.

doc/devel/pr_guide.rst

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ We value contributions from people with all levels of experience. In particular,
1212
if this is your first PR not everything has to be perfect. We'll guide you
1313
through the PR process. Nevertheless, please try to follow our guidelines as well
1414
as you can to help make the PR process quick and smooth. If your pull request is
15-
incomplete or a work-in-progress, please mark it as a `draft pull requests <https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests#draft-pull-requests>`_
15+
incomplete or a work-in-progress, please mark it as a :ref:`draft pull request <draft-pr>`
1616
on GitHub and specify what feedback from the developers would be helpful.
1717

1818
Please be patient with reviewers. We try our best to respond quickly, but we have
@@ -118,6 +118,22 @@ Workflow
118118
Detailed guidelines
119119
===================
120120

121+
.. _draft-pr:
122+
123+
Draft PRs
124+
---------
125+
126+
Authors may create a `draft PR`_ (or change to draft status later) if the code
127+
is not yet ready for a regular full review. Typical use cases are posting code
128+
as a basis for discussion or signalling that you intend to rework the code as
129+
a result of feedback. Authors should clearly communicate why the PR has draft
130+
status and what needs to be done to make it ready for review. In particular,
131+
they should explicitly ask for specific feedback if needed. By default,
132+
reviewers will not look at the code of a draft PR and only respond to specific
133+
questions by the author.
134+
135+
.. _draft PR: https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests#draft-pull-requests
136+
121137
.. _pr-documentation:
122138

123139
Documentation

0 commit comments

Comments
 (0)