You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
DOC: Update triage team nomination instructions (matplotlib#31089)
* DOC: Update triage team nomination instructions
* DOC: More updates to triage triage doc
* DOC: Try to fix linting issue in triage.rst
* Address review comments
* Update nomination instructions and categories
* Add @ to staff groups
* Add nomination steps and follow-up for objections
* Lint
* Add triager to discourse group
- **reproduce the issue**, if the posted code is a bug label the issue
82
-
with "status: confirmed bug".
83
-
84
-
- **identify regressions**, determine if the reported bug used to
74
+
* **reproduce the issue**, and if the posted code is a bug label the issue
75
+
with `status: confirmed bug <https://github.com/matplotlib/matplotlib/issues?q=sort%3Aupdated-desc+state%3Aopen+label%3A%22status%3A+confirmed+bug%22>`_.
76
+
* **identify regressions**, determine if the reported bug used to
85
77
work as expected in a recent version of Matplotlib and if so
86
78
determine the last working version. Regressions should be
87
79
milestoned for the next bug-fix release and may be labeled as
88
80
"Release critical".
89
-
90
-
- **close usage questions** and politely point the reporter to use
91
-
`discourse <https://discourse.matplotlib.org>`_ or Stack Overflow
92
-
instead and label as "community support".
93
-
94
-
- **close duplicate issues**, after checking that they are
81
+
* **close duplicate issues**, after checking that they are
95
82
indeed duplicate. Ideally, the original submitter moves the
96
-
discussion to the older, duplicate issue
97
-
98
-
- **close issues that cannot be replicated**, after leaving time (at
99
-
least a week) to add extra information
100
-
83
+
discussion to the older, duplicate issue.
84
+
* **close issues that cannot be replicated**, after leaving time (at
85
+
least a week) to add extra information.
86
+
* **invite contributors to engage with the community** if the issue requires
87
+
more information or discussion. These discussions can take place in the
88
+
`weekly community meetings <https://scientific-python.org/calendars>`__, or
89
+
on `discourse <https://discourse.matplotlib.org>`__.
101
90
102
91
.. topic:: Closing issues: a tough call
103
92
@@ -107,13 +96,6 @@ important tasks:
107
96
question or has been considered as unclear for many years, then it
108
97
should be closed.
109
98
110
-
Prepare PRs for review
111
-
======================
112
-
113
-
Reviewing code is also encouraged. Contributors and users are welcome to
114
-
participate to the review process following our :ref:`review guidelines
115
-
<pr-guidelines>`.
116
-
117
99
.. _triage_workflow:
118
100
119
101
Triage workflow
@@ -127,13 +109,19 @@ The following workflow is a good way to approach issue triaging:
127
109
Matplotlib project itself, beyond just using the library. As such,
128
110
we want it to be a welcoming, pleasant experience.
129
111
130
-
#. Is this a usage question? If so close it with a polite message.
112
+
#. Is this a usage question?
113
+
114
+
If so, close it with a polite message, point the reporter to use
115
+
`discourse <https://discourse.matplotlib.org>`__ or Stack Overflow instead
116
+
and use the
117
+
`community support <https://github.com/matplotlib/matplotlib/issues?q=sort%3Aupdated-desc+state%3Aopen+label%3A%22Community+support%22>`__
118
+
label, if you have the necessary permissions.
131
119
132
120
#. Is the necessary information provided?
133
121
134
122
Check that the poster has filled in the issue template. If crucial
135
123
information (the version of Python, the version of Matplotlib used,
136
-
the OS, and the backend), is missing politely ask the original
124
+
the OS, and the backend) is missing, politely ask the original
137
125
poster to provide the information.
138
126
139
127
#. Is the issue minimal and reproducible?
@@ -154,7 +142,7 @@ The following workflow is a good way to approach issue triaging:
154
142
OS, Python, and Matplotlib versions.
155
143
156
144
If we need more information from either this or the previous step
157
-
please label the issue with "status: needs clarification".
145
+
please label the issue with `status: needs clarification<https://github.com/matplotlib/matplotlib/issues?q=sort%3Aupdated-desc+state%3Aopen+label%3A%22status%3A+needs+clarification%22>`_.
158
146
159
147
#. Is this a regression?
160
148
@@ -169,7 +157,6 @@ The following workflow is a good way to approach issue triaging:
169
157
<https://git-scm.com/docs/git-bisect>`_ to find the first commit
170
158
where it was broken.
171
159
172
-
173
160
#. Is this a duplicate issue?
174
161
175
162
We have many open issues. If a new issue seems to be a duplicate,
@@ -182,37 +169,85 @@ The following workflow is a good way to approach issue triaging:
182
169
slightly different example, add it to the original issue as a comment
183
170
or an edit to the original post.
184
171
185
-
Label the closed issue with "status: duplicate"
172
+
Label the closed issue with `status: duplicate<https://github.com/matplotlib/matplotlib/issues?q=sort%3Aupdated-desc+state%3Aopen+label%3A%22status%3A+duplicate%22>`__.
186
173
187
174
#. Make sure that the title accurately reflects the issue. If you have the
188
175
necessary permissions edit it yourself if it's not clear.
189
176
190
-
#. Add the relevant labels, such as "Documentation" when the issue is
191
-
about documentation, "Bug" if it is clearly a bug, "New feature" if it
192
-
is a new feature request, ...
177
+
#. Add the relevant labels, such as `Documentation <https://github.com/matplotlib/matplotlib/labels?q=documentation>`__
178
+
when the issue is about documentation, `status: confirmed bug <https://github.com/matplotlib/matplotlib/issues?q=sort%3Aupdated-desc+state%3Aopen+label%3A%22status%3A+confirmed+bug%22>`__
179
+
if it is clearly a bug, `New feature <https://github.com/matplotlib/matplotlib/issues?q=sort%3Aupdated-desc+state%3Aopen+label%3A%22New+feature%22>`__
180
+
if it is a new feature request, etc.
181
+
182
+
An additional useful step can be to tag with the relevant "topic: ..." label,
183
+
e.g. "topic: widgets/UI" or "topic: animation".
184
+
185
+
Take some time to familiarize yourself with the available labels and their
186
+
meaning, and try to use them consistently.
187
+
188
+
.. topic:: Good first issues
193
189
194
-
If the issue is clearly defined and the fix seems relatively
195
-
straightforward, label the issue as “Good first issue” (and
196
-
possibly a description of the fix or a hint as to where in the
197
-
code base to look to get started).
190
+
If the issue is clearly defined, the fix seems relatively straightforward,
191
+
and there is consensus on what the solution is among maintainers, label the
192
+
issue as
193
+
`Good first issue <https://github.com/matplotlib/matplotlib/issues?q=sort%3Aupdated-desc%20state%3Aopen%20label%3A%22Good%20first%20issue%22>`_
194
+
(and possibly a description of the fix or a hint as to where in the
195
+
code base to look to get started).
198
196
199
-
An additional useful step can be to tag the corresponding module e.g.
200
-
the "GUI/Qt" label when relevant.
197
+
Note that good first issues are intended to onboard newcomers with a genuine
198
+
interest in improving Matplotlib, in the hopes that they will continue to
199
+
participate in our development community; therefore, the use of AI tools to
200
+
resolve these issues is not appropriate.
201
+
202
+
Preparing PRs for review
203
+
========================
204
+
205
+
Doing initial reviews of contributions is also encouraged. Contributors and
206
+
users are welcome to participate to the review process following our
207
+
:ref:`review guidelines <pr-guidelines>`. In particular, if you identify a PR
0 commit comments