Skip to content

Commit 294a9f4

Browse files
committed
DOC: Add policy for people stating concurrent interest
While we formally do not resevere issues, it happens regularly, in particular on good first issues, that multiple people communicate interest to work on the issue (most recently in matplotlib#29647). I feel the need to give a procedure how to handle this. We don't want person A to state interest, start coding and meanwhile person B snatches the topic and provides a PR. And I don't want to manually sort who should be doing what anymore. With this addition we can simply point to our guidelines, and people can have clear expectations. I therefore propose a courtsy time of 24h for not opening a PR if somebody has stated interest to do so. - The 24h is somewhat arbitrary, but long enough so that somebody who is actively working on the issue should produce a result, and short enough to not block other people.
1 parent c9402f3 commit 294a9f4

File tree

1 file changed

+21
-9
lines changed

1 file changed

+21
-9
lines changed

doc/devel/contribute.rst

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -318,15 +318,27 @@ chat room and for community questions reach out at community_.
318318
Choose an issue
319319
===============
320320

321-
In general, the Matplotlib project does not assign issues. Issues are
322-
"assigned" or "claimed" by opening a PR; there is no other assignment
323-
mechanism. If you have opened such a PR, please comment on the issue thread to
324-
avoid duplication of work. Please check if there is an existing PR for the
325-
issue you are addressing. If there is, try to work with the author by
326-
submitting reviews of their code or commenting on the PR rather than opening
327-
a new PR; duplicate PRs are subject to being closed. However, if the existing
328-
PR is an outline, unlikely to work, or stalled, and the original author is
329-
unresponsive, feel free to open a new PR referencing the old one.
321+
In general, the Matplotlib project does not assign issues. You do not need to
322+
ask whether you can work on an issue. Nevertheless, we encourage following these
323+
guidelines to prevent duplicated work:
324+
325+
If there is an existing pull request (PR) for the issue, try to work with the PR
326+
author by submitting reviews of their code or commenting on the PR rather than
327+
opening a new PR; duplicate PRs may be closed. However, if the existing
328+
PR has stalled, and the original author is unresponsive, feel free to open a new
329+
PR referencing the old one.
330+
331+
If there is no existing PR and it's not obvious that somebody else is working on
332+
the topic - either by recent discussion or explicit statement, you can start
333+
working on it right away.
334+
335+
You may optionally leave a comment "I've started working on this"; please only do
336+
this if you actually work on it, do not use this as reservation because you would
337+
like to work on it tomorrow or later. Such a comment is not a formal reservation
338+
or assignment. It's just a way to prevent duplicate work. If there's no follow-up
339+
discussion or PR within a reasonable time (typically 2 days), we assume that the
340+
interest has declined, and anybody is free to pick up the topic.
341+
330342

331343
.. _how-to-pull-request:
332344

0 commit comments

Comments
 (0)