Skip to content

Commit 43332c2

Browse files
DOC: Update Issue Triage Instructions (#55373)
1 parent 21689e5 commit 43332c2

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

doc/source/development/maintaining.rst

+13-9
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,9 @@ reading.
4444
Issue triage
4545
------------
4646

47+
Triage is an important first step in addressing issues reported by the community, and even
48+
partial contributions are a great way to help maintain pandas. Only remove the "Needs Triage"
49+
tag once all of the steps below have been completed.
4750

4851
Here's a typical workflow for triaging a newly opened issue.
4952

@@ -67,9 +70,9 @@ Here's a typical workflow for triaging a newly opened issue.
6770
3. **Is this a duplicate issue?**
6871

6972
We have many open issues. If a new issue is clearly a duplicate, label the
70-
new issue as "Duplicate" assign the milestone "No Action", and close the issue
71-
with a link to the original issue. Make sure to still thank the reporter, and
72-
encourage them to chime in on the original issue, and perhaps try to fix it.
73+
new issue as "Duplicate" and close the issue with a link to the original issue.
74+
Make sure to still thank the reporter, and encourage them to chime in on the
75+
original issue, and perhaps try to fix it.
7376

7477
If the new issue provides relevant information, such as a better or slightly
7578
different example, add it to the original issue as a comment or an edit to
@@ -90,15 +93,20 @@ Here's a typical workflow for triaging a newly opened issue.
9093
If a reproducible example is provided, but you see a simplification,
9194
edit the original post with your simpler reproducible example.
9295

96+
Ensure the issue exists on the main branch and that it has the "Needs Triage" tag
97+
until all steps have been completed. Add a comment to the issue once you have
98+
verified it exists on the main branch, so others know it has been confirmed.
99+
93100
5. **Is this a clearly defined feature request?**
94101

95102
Generally, pandas prefers to discuss and design new features in issues, before
96103
a pull request is made. Encourage the submitter to include a proposed API
97104
for the new feature. Having them write a full docstring is a good way to
98105
pin down specifics.
99106

100-
We'll need a discussion from several pandas maintainers before deciding whether
101-
the proposal is in scope for pandas.
107+
Tag new feature requests with "Needs Discussion", as we'll need a discussion
108+
from several pandas maintainers before deciding whether the proposal is in
109+
scope for pandas.
102110

103111
6. **Is this a usage question?**
104112

@@ -117,10 +125,6 @@ Here's a typical workflow for triaging a newly opened issue.
117125
If the issue is clearly defined and the fix seems relatively straightforward,
118126
label the issue as "Good first issue".
119127

120-
Typically, new issues will be assigned the "Contributions welcome" milestone,
121-
unless it's know that this issue should be addressed in a specific release (say
122-
because it's a large regression).
123-
124128
Once you have completed the above, make sure to remove the "needs triage" label.
125129

126130
.. _maintaining.regressions:

0 commit comments

Comments
 (0)