@@ -30,28 +30,41 @@ Pandas is largely a volunteer project, so these tasks shouldn't be read as
30
30
of what it means to be a maintainer.
31
31
32
32
* Triage newly filed issues (see :ref: `maintaining.triage `)
33
- * Review newly opened pull request
33
+ * Review newly opened pull requests
34
34
* Respond to updates on existing issues and pull requests
35
35
* 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.
36
41
37
42
.. _maintaining.triage :
38
43
39
44
Issue Triage
40
45
------------
41
46
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.
45
47
46
48
Here's a typical workflow for triaging a newly opened issue.
47
49
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? **
49
57
50
58
Ideally reporters would fill out the issue template, but many don't.
51
59
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.
53
63
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? **
55
68
56
69
We have many open issues. If a new issue is clearly a duplicate, label the
57
70
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.
62
75
different example, add it to the original issue as a comment or an edit to
63
76
the original post.
64
77
65
- 3 . **Is the issue minimal and reproducible **?
78
+ 4 . **Is the issue minimal and reproducible **?
66
79
67
80
For bug reports, we ask that the reporter provide a minimal reproducible
68
81
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.
74
87
75
88
If a reproducible example can't be provided, add the "Needs info" label.
76
89
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? **
78
94
79
95
Generally, pandas prefers to discuss and design new features in issues, before
80
96
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.
84
100
We'll need a discussion from several pandas maintainers before deciding whether
85
101
the proposal is in scope for pandas.
86
102
87
- 5 . **Is this a usage question? **
103
+ 6 . **Is this a usage question? **
88
104
89
105
We prefer that usage questions are asked on StackOverflow with the pandas
90
106
tag. https://stackoverflow.com/questions/tagged/pandas
@@ -93,12 +109,12 @@ Here's a typical workflow for triaging a newly opened issue.
93
109
let them know that in the future this kind of question should be on
94
110
StackOverflow, and close the issue.
95
111
96
- 6 . **What labels and milestones should I add? **
112
+ 7 . **What labels and milestones should I add? **
97
113
98
114
Apply the relevant labels. This is a bit of an art, and comes with experience.
99
115
Look at similar issues to get a feel for how things are labeled.
100
116
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,
102
118
label the issue as "Good first issue".
103
119
104
120
Typically, new issues will be assigned the "Contributions welcome" milestone,
@@ -112,7 +128,7 @@ Closing Issues
112
128
113
129
Be delicate here: many people interpret closing an issue as us saying that the
114
130
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,
116
132
or the feature is out of scope. Sometimes reporters just go away though, and
117
133
we'll close the issue after the conversation has died.
118
134
@@ -152,8 +168,8 @@ Cleaning up old Pull Requests
152
168
-----------------------------
153
169
154
170
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
157
173
so passes with no response, thank them for their work and close the pull request.
158
174
Comment on the original issue that "There's a stalled PR at #1234 that may be
159
175
helpful.", and perhaps label the issue as "Good first issue" if the PR was relatively
0 commit comments