Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit04c322d

Browse files
committed
DOC: Rewrite "Work on an issue" section
Make that section more understandable and actionablefor people unfamiliar with the GitHub interface andthe pull request process.
1 parent69f9ebf commit04c322d

File tree

2 files changed

+16
-9
lines changed

2 files changed

+16
-9
lines changed

‎doc/devel/contribute.rst

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -154,12 +154,19 @@ Work on an issue
154154
----------------
155155

156156
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>` (PR).
159+
We ask PR authors to
160+
`link the PR to the issue
161+
<https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue>`_.
162+
Such links are be displayed in the discussion thread as well as the sidebar
163+
on the issue page on GitHub.
164+
165+
Before starting to work on an issue, please check if there is already
166+
a linked PR. If there is, try to work with the author by
161167
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
168+
a new PR; duplicate PRs are unnecessary concurrent work and thus are subject
169+
to being closed. However, if the existing
163170
PR is an outline, unlikely to work, or stalled, and the original author is
164171
unresponsive, feel free to open a new PR referencing the old one.
165172

@@ -183,7 +190,7 @@ our code consistent and mitigating the impact of changes.
183190
*:ref:`pr-guidelines`
184191

185192
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
193+
:ref:`how-to-pull-request` If you get stuck, please reach out on the
187194
:ref:`contributor_incubator`
188195

189196
.. _contribute_documentation:
@@ -236,7 +243,7 @@ Instructions and guidelines for contributing documentation are found in:
236243
*:doc:`tag_guidelines`
237244

238245
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
246+
at:ref:`how-to-pull-request`. If that feels intimidating, we encourage you to
240247
`open an issue`_ describing what improvements you would make. If you get stuck,
241248
please reach out on the:ref:`contributor_incubator`
242249

@@ -260,7 +267,7 @@ please follow the :doc:`/project/citing` guidelines.
260267
If you have developed an extension to Matplotlib, please consider adding it to our
261268
`third party package<https://github.com/matplotlib/mpl-third-party>`_ list.
262269

263-
.. _how-to-contribute:
270+
.. _how-to-pull-request:
264271

265272
How to contribute via pull request
266273
==================================

‎doc/devel/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ New contributors
8181

8282
:octicon:`git-pull-request;1em;sd-text-info`:ref:`How do I claim an issue?<managing_issues_prs>`
8383

84-
:octicon:`codespaces;1em;sd-text-info`:ref:`How do I start a pull request?<how-to-contribute>`
84+
:octicon:`codespaces;1em;sd-text-info`:ref:`How do I start a pull request?<how-to-pull-request>`
8585

8686
..grid-item::
8787

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp