Skip to content

Commit 5772227

Browse files
committed
updates
1 parent ada0664 commit 5772227

File tree

1 file changed

+31
-15
lines changed

1 file changed

+31
-15
lines changed

doc/source/development/maintaining.rst

Lines changed: 31 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -30,28 +30,41 @@ Pandas is largely a volunteer project, so these tasks shouldn't be read as
3030
of what it means to be a maintainer.
3131

3232
* Triage newly filed issues (see :ref:`maintaining.triage`)
33-
* Review newly opened pull request
33+
* Review newly opened pull requests
3434
* Respond to updates on existing issues and pull requests
3535
* Drive discussion and decisions on stalled issues and pull requests
36+
* Provide experience / wisdom on API design questions to ensure consistency and maintainability
37+
* Project organization (run / attend developer meetings, represent pandas)
38+
39+
http://matthewrocklin.com/blog/2019/05/18/maintainer may be interesting background
40+
reading.
3641

3742
.. _maintaining.triage:
3843

3944
Issue Triage
4045
------------
4146

42-
The issue tracker is many people's first interaction with the pandas project itself,
43-
beyond just using the library. As such, we want it to be a welcoming, pleasant
44-
experience.
4547

4648
Here's a typical workflow for triaging a newly opened issue.
4749

48-
1. **Is the necessary information provided?**
50+
1. **Thank the reporter for opening an issue**
51+
52+
The issue tracker is many people's first interaction with the pandas project itself,
53+
beyond just using the library. As such, we want it to be a welcoming, pleasant
54+
experience.
55+
56+
2. **Is the necessary information provided?**
4957

5058
Ideally reporters would fill out the issue template, but many don't.
5159
If crucial information (like the version of pandas they used), is missing
52-
feel free to ask for that and label the issue with "Needs info".
60+
feel free to ask for that and label the issue with "Needs info". The
61+
report should follow the guidelines in :ref:`contributing.bug_reports`.
62+
You may want to link to that if they didn't follow the template.
5363

54-
2. **Is this a duplicate issue?**
64+
Make sure that the title accurately reflects the issue. Edit it yourself
65+
if it's not clear.
66+
67+
3. **Is this a duplicate issue?**
5568

5669
We have many open issues. If a new issue is clearly a duplicate, label the
5770
new issue as "Duplicate" assign the milestone "No Action", and close the issue
@@ -62,7 +75,7 @@ Here's a typical workflow for triaging a newly opened issue.
6275
different example, add it to the original issue as a comment or an edit to
6376
the original post.
6477

65-
3. **Is the issue minimal and reproducible**?
78+
4. **Is the issue minimal and reproducible**?
6679

6780
For bug reports, we ask that the reporter provide a minimal reproducible
6881
example. See http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports
@@ -74,7 +87,10 @@ Here's a typical workflow for triaging a newly opened issue.
7487

7588
If a reproducible example can't be provided, add the "Needs info" label.
7689

77-
4. **Is this a clearly defined feature request?**
90+
If a reproducible example is provided, but you see a simplification,
91+
edit the original post with your simpler reproducible example.
92+
93+
5. **Is this a clearly defined feature request?**
7894

7995
Generally, pandas prefers to discuss and design new features in issues, before
8096
a pull request is made. Encourage the submitter to include a proposed API
@@ -84,7 +100,7 @@ Here's a typical workflow for triaging a newly opened issue.
84100
We'll need a discussion from several pandas maintainers before deciding whether
85101
the proposal is in scope for pandas.
86102

87-
5. **Is this a usage question?**
103+
6. **Is this a usage question?**
88104

89105
We prefer that usage questions are asked on StackOverflow with the pandas
90106
tag. https://stackoverflow.com/questions/tagged/pandas
@@ -93,12 +109,12 @@ Here's a typical workflow for triaging a newly opened issue.
93109
let them know that in the future this kind of question should be on
94110
StackOverflow, and close the issue.
95111

96-
6. **What labels and milestones should I add?**
112+
7. **What labels and milestones should I add?**
97113

98114
Apply the relevant labels. This is a bit of an art, and comes with experience.
99115
Look at similar issues to get a feel for how things are labeled.
100116

101-
If there issue is clearly defined and the fix seems relatively straightforward,
117+
If the issue is clearly defined and the fix seems relatively straightforward,
102118
label the issue as "Good first issue".
103119

104120
Typically, new issues will be assigned the "Contributions welcome" milestone,
@@ -112,7 +128,7 @@ Closing Issues
112128

113129
Be delicate here: many people interpret closing an issue as us saying that the
114130
conversation is over. It's typically best to give the reporter some time to
115-
self-close their issue if it's determined that the behavior is not a bug,
131+
respond or self-close their issue if it's determined that the behavior is not a bug,
116132
or the feature is out of scope. Sometimes reporters just go away though, and
117133
we'll close the issue after the conversation has died.
118134

@@ -152,8 +168,8 @@ Cleaning up old Pull Requests
152168
-----------------------------
153169

154170
Occasionally, contributors are unable to finish off a pull request.
155-
If some time has passed (a week, say) since the last review requesting changes,
156-
gently ask if they're still interested in working on this. If another week or
171+
If some time has passed (two weeks, say) since the last review requesting changes,
172+
gently ask if they're still interested in working on this. If another two weeks or
157173
so passes with no response, thank them for their work and close the pull request.
158174
Comment on the original issue that "There's a stalled PR at #1234 that may be
159175
helpful.", and perhaps label the issue as "Good first issue" if the PR was relatively

0 commit comments

Comments
 (0)