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

Commit380bba1

Browse files
authored
Merge pull request#28024 from timhoffm/doc-work-issue
DOC: Rewrite "Work on an issue" section
2 parents69f9ebf +22b4a52 commit380bba1

File tree

2 files changed

+14
-9
lines changed

2 files changed

+14
-9
lines changed

‎doc/devel/contribute.rst

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -154,12 +154,17 @@ 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>`.
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
161165
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
163168
PR is an outline, unlikely to work, or stalled, and the original author is
164169
unresponsive, feel free to open a new PR referencing the old one.
165170

@@ -183,7 +188,7 @@ our code consistent and mitigating the impact of changes.
183188
*:ref:`pr-guidelines`
184189

185190
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
187192
:ref:`contributor_incubator`
188193

189194
.. _contribute_documentation:
@@ -236,7 +241,7 @@ Instructions and guidelines for contributing documentation are found in:
236241
*:doc:`tag_guidelines`
237242

238243
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
240245
`open an issue`_ describing what improvements you would make. If you get stuck,
241246
please reach out on the:ref:`contributor_incubator`
242247

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

263-
.. _how-to-contribute:
268+
.. _how-to-pull-request:
264269

265270
How to contribute via pull request
266271
==================================

‎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