-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathtriage.html
More file actions
747 lines (560 loc) · 33.1 KB
/
Copy pathtriage.html
File metadata and controls
747 lines (560 loc) · 33.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<title>Bug triaging and issue curation — Matplotlib 3.7.2 documentation</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "light";
</script>
<!-- Loaded before other Sphinx assets -->
<link href="../_static/styles/theme.css?digest=796348d33e8b1d947c94" rel="stylesheet">
<link href="../_static/styles/bootstrap.css?digest=796348d33e8b1d947c94" rel="stylesheet">
<link href="../_static/styles/pydata-sphinx-theme.css?digest=796348d33e8b1d947c94" rel="stylesheet">
<link href="../_static/vendor/fontawesome/6.1.2/css/all.min.css?digest=796348d33e8b1d947c94" rel="stylesheet">
<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-solid-900.woff2">
<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2">
<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2">
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v3.7.2-2-g4915f574b8" />
<link rel="stylesheet" type="text/css" href="../_static/css/style.css?v3.7.2-2-g4915f574b8" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v3.7.2-2-g4915f574b8" />
<link rel="stylesheet" type="text/css" href="../_static/plot_directive.css?v3.7.2-2-g4915f574b8" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v3.7.2-2-g4915f574b8" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery.css?v3.7.2-2-g4915f574b8" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-binder.css?v3.7.2-2-g4915f574b8" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-dataframe.css?v3.7.2-2-g4915f574b8" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-rendered-html.css?v3.7.2-2-g4915f574b8" />
<link rel="stylesheet" type="text/css" href="../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css?v3.7.2-2-g4915f574b8" />
<link rel="stylesheet" type="text/css" href="../_static/mpl.css?v3.7.2-2-g4915f574b8" />
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=796348d33e8b1d947c94">
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=796348d33e8b1d947c94">
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v3.7.2-2-g4915f574b8"></script>
<script src="../_static/jquery.js?v3.7.2-2-g4915f574b8"></script>
<script src="../_static/underscore.js?v3.7.2-2-g4915f574b8"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v3.7.2-2-g4915f574b8"></script>
<script src="../_static/doctools.js?v3.7.2-2-g4915f574b8"></script>
<script src="../_static/sphinx_highlight.js?v3.7.2-2-g4915f574b8"></script>
<script src="../_static/clipboard.min.js?v3.7.2-2-g4915f574b8"></script>
<script src="../_static/copybutton.js?v3.7.2-2-g4915f574b8"></script>
<script src="../_static/design-tabs.js?v3.7.2-2-g4915f574b8"></script>
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'devel/triage';</script>
<script>
DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://matplotlib.org/devdocs/_static/switcher.json?v3.7.2-2-g4915f574b8';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '3.7.2';
</script>
<link rel="canonical" href="https://matplotlib.org/stable/devel/triage.html" />
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.7.2 documentation"
href="../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Setting up Matplotlib for development" href="development_setup.html" />
<link rel="prev" title="Contributing" href="contributing.html" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="docsearch:language" content="en">
</head>
<body data-spy="scroll" data-target="#bd-toc-nav" data-offset="180" data-default-mode="">
<a class="skip-link" href="#main-content">Skip to main content</a>
<input type="checkbox" class="sidebar-toggle" name="__primary" id="__primary">
<label class="overlay overlay-primary" for="__primary"></label>
<input type="checkbox" class="sidebar-toggle" name="__secondary" id="__secondary">
<label class="overlay overlay-secondary" for="__secondary"></label>
<div class="search-button__wrapper">
<div class="search-button__overlay"></div>
<div class="search-button__search-container">
<form class="bd-search d-flex align-items-center" action="../search.html" method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false">
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form>
</div>
</div>
<nav class="bd-header navbar navbar-expand-lg bd-navbar" id="navbar-main"><div class="bd-header__inner bd-page-width">
<label class="sidebar-toggle primary-toggle" for="__primary">
<span class="fa-solid fa-bars"></span>
</label>
<div id="navbar-start">
<a class="navbar-brand logo" href="../index.html">
<img src="../_static/images/logo2.svg" class="logo__image only-light" alt="Logo image">
<img src="../_static/images/logo_dark.svg" class="logo__image only-dark" alt="Logo image">
</a>
</div>
<div class="col-lg-9 navbar-header-items">
<div id="navbar-center" class="mr-auto">
<div class="navbar-center-item">
<ul id="navbar-main-elements" class="navbar-nav">
<li class="nav-item">
<a class="reference internal nav-link" href="../plot_types/index.html">Plot types</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../gallery/index.html">Examples</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../tutorials/index.html">Tutorials</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../api/index.html">Reference</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../users/index.html">User guide</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="index.html">Develop</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../users/release_notes.html">Releases</a>
</li>
</ul>
</div>
</div>
<div id="navbar-end">
<div class="navbar-end-item navbar-persistent--container">
<button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
</button>
</div>
<div class="navbar-end-item">
<button class="theme-switch-button btn btn-sm btn-outline-primary navbar-btn rounded-circle" title="light/dark" aria-label="light/dark" data-toggle="tooltip">
<span class="theme-switch" data-mode="light"><i class="fa-solid fa-sun"></i></span>
<span class="theme-switch" data-mode="dark"><i class="fa-solid fa-moon"></i></span>
<span class="theme-switch" data-mode="auto"><i class="fa-solid fa-circle-half-stroke"></i></span>
</button>
</div>
<div class="navbar-end-item">
<div class="version-switcher__container dropdown">
<button type="button" class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle" data-toggle="dropdown">
stable <!-- this text may get changed later by javascript -->
<span class="caret"></span>
</button>
<div class="version-switcher__menu dropdown-menu list-group-flush py-0">
<!-- dropdown will be populated by javascript on page load -->
</div>
</div>
</div>
<div class="navbar-end-item">
<ul id="navbar-icon-links" class="navbar-nav" aria-label="Icon Links">
<li class="nav-item">
<a href="https://gitter.im/matplotlib/matplotlib" title="Gitter" class="nav-link" rel="noopener" target="_blank" data-toggle="tooltip"><span><i class="fa-brands fa-gitter"></i></span>
<label class="sr-only">Gitter</label></a>
</li>
<li class="nav-item">
<a href="https://discourse.matplotlib.org" title="Discourse" class="nav-link" rel="noopener" target="_blank" data-toggle="tooltip"><span><i class="fa-brands fa-discourse"></i></span>
<label class="sr-only">Discourse</label></a>
</li>
<li class="nav-item">
<a href="https://github.com/matplotlib/matplotlib" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-toggle="tooltip"><span><i class="fa-brands fa-github"></i></span>
<label class="sr-only">GitHub</label></a>
</li>
<li class="nav-item">
<a href="https://twitter.com/matplotlib/" title="Twitter" class="nav-link" rel="noopener" target="_blank" data-toggle="tooltip"><span><i class="fa-brands fa-twitter"></i></span>
<label class="sr-only">Twitter</label></a>
</li>
</ul>
</div>
</div>
</div>
<div class="navbar-persistent--mobile">
<button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
</button>
</div>
<label class="sidebar-toggle secondary-toggle" for="__secondary">
<span class="fa-solid fa-outdent"></span>
</label>
</div>
</nav>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<div class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
<div class="sidebar-header-items__center">
<div class="navbar-center-item">
<ul id="navbar-main-elements" class="navbar-nav">
<li class="nav-item">
<a class="reference internal nav-link" href="../plot_types/index.html">Plot types</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../gallery/index.html">Examples</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../tutorials/index.html">Tutorials</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../api/index.html">Reference</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../users/index.html">User guide</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="index.html">Develop</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../users/release_notes.html">Releases</a>
</li>
</ul>
</div>
</div>
<div class="sidebar-header-items__end">
<div class="navbar-end-item">
<button class="theme-switch-button btn btn-sm btn-outline-primary navbar-btn rounded-circle" title="light/dark" aria-label="light/dark" data-toggle="tooltip">
<span class="theme-switch" data-mode="light"><i class="fa-solid fa-sun"></i></span>
<span class="theme-switch" data-mode="dark"><i class="fa-solid fa-moon"></i></span>
<span class="theme-switch" data-mode="auto"><i class="fa-solid fa-circle-half-stroke"></i></span>
</button>
</div>
<div class="navbar-end-item">
<div class="version-switcher__container dropdown">
<button type="button" class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle" data-toggle="dropdown">
stable <!-- this text may get changed later by javascript -->
<span class="caret"></span>
</button>
<div class="version-switcher__menu dropdown-menu list-group-flush py-0">
<!-- dropdown will be populated by javascript on page load -->
</div>
</div>
</div>
<div class="navbar-end-item">
<ul id="navbar-icon-links" class="navbar-nav" aria-label="Icon Links">
<li class="nav-item">
<a href="https://gitter.im/matplotlib/matplotlib" title="Gitter" class="nav-link" rel="noopener" target="_blank" data-toggle="tooltip"><span><i class="fa-brands fa-gitter"></i></span>
<label class="sr-only">Gitter</label></a>
</li>
<li class="nav-item">
<a href="https://discourse.matplotlib.org" title="Discourse" class="nav-link" rel="noopener" target="_blank" data-toggle="tooltip"><span><i class="fa-brands fa-discourse"></i></span>
<label class="sr-only">Discourse</label></a>
</li>
<li class="nav-item">
<a href="https://github.com/matplotlib/matplotlib" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-toggle="tooltip"><span><i class="fa-brands fa-github"></i></span>
<label class="sr-only">GitHub</label></a>
</li>
<li class="nav-item">
<a href="https://twitter.com/matplotlib/" title="Twitter" class="nav-link" rel="noopener" target="_blank" data-toggle="tooltip"><span><i class="fa-brands fa-twitter"></i></span>
<label class="sr-only">Twitter</label></a>
</li>
</ul>
</div>
</div>
</div>
<div class="sidebar-start-items sidebar-primary__section">
<div class="sidebar-start-items__item"><nav class="bd-links" id="bd-docs-nav" aria-label="Section navigation">
<p class="bd-links__title" role="heading" aria-level="1">
Section Navigation
</p>
<div class="bd-toc-item navbar-nav">
<ul class="current nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1 current active"><a class="current reference internal" href="#">Bug triaging and issue curation</a></li>
<li class="toctree-l1"><a class="reference internal" href="development_setup.html">Setting up Matplotlib for development</a></li>
<li class="toctree-l1"><a class="reference internal" href="development_workflow.html">Development workflow</a></li>
<li class="toctree-l1"><a class="reference internal" href="testing.html">Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="documenting_mpl.html">Writing documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="style_guide.html">Documentation style guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="coding_guide.html">Pull request guidelines</a></li>
<li class="toctree-l1"><a class="reference internal" href="release_guide.html">Release guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="dependencies.html">Dependencies</a></li>
<li class="toctree-l1"><a class="reference internal" href="min_dep_policy.html">Minimum version of dependencies policy</a></li>
<li class="toctree-l1"><a class="reference internal" href="maintainer_workflow.html">Maintainer workflow</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="MEP/index.html">Matplotlib Enhancement Proposals</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="MEP/template.html">MEP Template</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP08.html">MEP8: PEP8</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP09.html">MEP9: Global interaction manager</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP10.html">MEP10: Docstring consistency</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP11.html">MEP11: Third-party dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP12.html">MEP12: Improve Gallery and Examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP13.html">MEP13: Use properties for Artists</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP14.html">MEP14: Text handling</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP15.html">MEP15: Fix axis autoscaling when limits are specified for one axis only</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP19.html">MEP19: Continuous Integration</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP21.html">MEP21: color and cm refactor</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP22.html">MEP22: Toolbar rewrite</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP23.html">MEP23: Multiple Figures per GUI window</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP24.html">MEP24: Negative radius in polar plots</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP25.html">MEP25: Serialization</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP26.html">MEP26: Artist styling</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP27.html">MEP27: Decouple pyplot from backends</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP28.html">MEP28: Remove Complexity from Axes.boxplot</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP29.html">MEP29: Text light markup</a></li>
</ul>
</li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="license.html">Licenses</a></li>
<li class="toctree-l1"><a class="reference internal" href="color_changes.html">Default color changes</a></li>
</ul>
</div>
</nav>
</div>
</div>
<div class="sidebar-end-items sidebar-primary__section">
<div class="sidebar-end-items__item">
</div>
</div>
<div id="rtd-footer-container"></div>
</div>
<main id="main-content" class="bd-main">
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article">
</div>
<article class="bd-article" role="main">
<section id="bug-triaging-and-issue-curation">
<span id="bug-triaging"></span><h1>Bug triaging and issue curation<a class="headerlink" href="#bug-triaging-and-issue-curation" title="Permalink to this heading">#</a></h1>
<p>The <a class="reference external" href="https://github.com/matplotlib/matplotlib/issues">issue tracker</a>
is important to communication in the project because it serves as the
centralized location for making feature requests, reporting bugs,
identifying major projects to work on, and discussing priorities. For
this reason, it is important to curate the issue list, adding labels
to issues and closing issues that are resolved or unresolvable.</p>
<p>Triaging issues does not require any particular expertise in the
internals of Matplotlib, is extremely valuable to the project, and we
welcome anyone to participate in issue triage! However, people who
are not part of the Matplotlib organization do not have <a class="reference external" href="https://docs.github.com/en/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization">permissions
to change milestones, add labels, or close issue</a>.
If you do not have enough GitHub permissions do something (e.g. add a
label, close an issue), please leave a comment with your
recommendations!</p>
<section id="working-on-issues-to-improve-them">
<h2>Working on issues to improve them<a class="headerlink" href="#working-on-issues-to-improve-them" title="Permalink to this heading">#</a></h2>
<p>Improving issues increases their chances of being successfully resolved.
Guidelines on submitting good issues can be found <a class="reference internal" href="contributing.html#submitting-a-bug-report"><span class="std std-ref">here</span></a>.
A third party can give useful feedback or even add
comments on the issue.
The following actions are typically useful:</p>
<blockquote>
<div><ul class="simple">
<li><p>documenting issues that are missing elements to reproduce the problem
such as code samples</p></li>
<li><p>suggesting better use of code formatting (e.g. triple back ticks in the
markdown).</p></li>
<li><p>suggesting to reformulate the title and description to make them more
explicit about the problem to be solved</p></li>
<li><p>linking to related issues or discussions while briefly describing
how they are related, for instance "See also #xyz for a similar
attempt at this" or "See also #xyz where the same thing was
reported" provides context and helps the discussion</p></li>
<li><p>verifying that the issue is reproducible</p></li>
<li><p>classify the issue as a feature request, a long standing bug or a
regression</p></li>
</ul>
</div></blockquote>
<aside class="topic">
<p class="topic-title">Fruitful discussions</p>
<p>Online discussions may be harder than it seems at first glance, in
particular given that a person new to open-source may have a very
different understanding of the process than a seasoned maintainer.</p>
<p>Overall, it is useful to stay positive and assume good will. <a class="reference external" href="http://gael-varoquaux.info/programming/technical-discussions-are-hard-a-few-tips.html">The
following article</a>
explores how to lead online discussions in the context of open source.</p>
</aside>
</section>
<section id="triage-team">
<h2>Triage team<a class="headerlink" href="#triage-team" title="Permalink to this heading">#</a></h2>
<p>If you would like to join the triage team:</p>
<ol class="arabic simple">
<li><p>Correctly triage 2-3 issues.</p></li>
<li><p>Ask someone on in the Matplotlib organization (publicly or privately) to
recommend you to the triage team (look for "Member" on the top-right of
comments on GitHub). If you worked with someone on the issues triaged, they
would be a good person to ask.</p></li>
<li><p>Responsibly exercise your new power!</p></li>
</ol>
<p>Anyone with commit or triage rights may nominate a user to be invited to join
the triage team by emailing <a class="reference external" href="mailto:matplotlib-steering-council%40numfocus.org">matplotlib-steering-council<span>@</span>numfocus<span>.</span>org</a> .</p>
</section>
<section id="triaging-operations-for-members-of-the-core-and-triage-teams">
<h2>Triaging operations for members of the core and triage teams<a class="headerlink" href="#triaging-operations-for-members-of-the-core-and-triage-teams" title="Permalink to this heading">#</a></h2>
<p>In addition to the above, members of the core team and the triage team
can do the following important tasks:</p>
<ul class="simple">
<li><p>Update labels for issues and PRs: see the list of <a class="reference external" href="https://github.com/matplotlib/matplotlib/labels">available GitHub
labels</a>.</p></li>
<li><p>Triage issues:</p>
<ul>
<li><p><strong>reproduce the issue</strong>, if the posted code is a bug label the issue
with "status: confirmed bug".</p></li>
<li><p><strong>identify regressions</strong>, determine if the reported bug used to
work as expected in a recent version of Matplotlib and if so
determine the last working version. Regressions should be
milestoned for the next bug-fix release and may be labeled as
"Release critical".</p></li>
<li><p><strong>close usage questions</strong> and politely point the reporter to use
<a class="reference external" href="https://discourse.matplotlib.org">discourse</a> or Stack Overflow
instead and label as "community support".</p></li>
<li><p><strong>close duplicate issues</strong>, after checking that they are
indeed duplicate. Ideally, the original submitter moves the
discussion to the older, duplicate issue</p></li>
<li><p><strong>close issues that cannot be replicated</strong>, after leaving time (at
least a week) to add extra information</p></li>
</ul>
</li>
</ul>
<aside class="topic">
<p class="topic-title">Closing issues: a tough call</p>
<p>When uncertain on whether an issue should be closed or not, it is
best to strive for consensus with the original poster, and possibly
to seek relevant expertise. However, when the issue is a usage
question or has been considered as unclear for many years, then it
should be closed.</p>
</aside>
</section>
<section id="a-typical-workflow-for-triaging-issues">
<h2>A typical workflow for triaging issues<a class="headerlink" href="#a-typical-workflow-for-triaging-issues" title="Permalink to this heading">#</a></h2>
<p>The following workflow <a class="footnote-reference brackets" href="#id2" id="id1" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a> is a good way to approach issue triaging:</p>
<ol class="arabic">
<li><p>Thank the reporter for opening an issue</p>
<p>The issue tracker is many people’s first interaction with the
Matplotlib project itself, beyond just using the library. As such,
we want it to be a welcoming, pleasant experience.</p>
</li>
<li><p>Is this a usage question? If so close it with a polite message.</p></li>
<li><p>Is the necessary information provided?</p>
<p>Check that the poster has filled in the issue template. If crucial
information (the version of Python, the version of Matplotlib used,
the OS, and the backend), is missing politely ask the original
poster to provide the information.</p>
</li>
<li><p>Is the issue minimal and reproducible?</p>
<p>For bug reports, we ask that the reporter provide a minimal
reproducible example. See <a class="reference external" href="https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports">this useful post</a>
by Matthew Rocklin for a good explanation. If the example is not
reproducible, or if it's clearly not minimal, feel free to ask the reporter
if they can provide an example or simplify the provided one.
Do acknowledge that writing minimal reproducible examples is hard work.
If the reporter is struggling, you can try to write one yourself.</p>
<p>If a reproducible example is provided, but you see a simplification,
add your simpler reproducible example.</p>
<p>If you can not reproduce the issue, please report that along with your
OS, Python, and Matplotlib versions.</p>
<p>If we need more information from either this or the previous step
please label the issue with "status: needs clarification".</p>
</li>
<li><p>Is this a regression?</p>
<p>While we strive for a bug-free library, regressions are the highest
priority. If we have broken user-code that <em>used to</em> work, we should
fix that in the next patch release!</p>
<p>Try to determine when the regression happened by running the
reproduction code against older versions of Matplotlib. This can
be done by released versions of Matplotlib (to get the version it
last worked in) or by using <a class="reference external" href="https://git-scm.com/docs/git-bisect">git bisect</a> to find the first commit
where it was broken.</p>
</li>
<li><p>Is this a duplicate issue?</p>
<p>We have many open issues. If a new issue seems to be a duplicate,
point to the original issue. If it is a clear duplicate, or consensus
is that it is redundant, close it. Make sure to still thank the
reporter, and encourage them to chime in on the original issue, and
perhaps try to fix it.</p>
<p>If the new issue provides relevant information, such as a better or
slightly different example, add it to the original issue as a comment
or an edit to the original post.</p>
<p>Label the closed issue with "status: duplicate"</p>
</li>
<li><p>Make sure that the title accurately reflects the issue. If you have the
necessary permissions edit it yourself if it's not clear.</p></li>
<li><p>Add the relevant labels, such as "Documentation" when the issue is
about documentation, "Bug" if it is clearly a bug, "New feature" if it
is a new feature request, ...</p>
<p>If the issue is clearly defined and the fix seems relatively
straightforward, label the issue as “Good first issue” (and
possibly a description of the fix or a hint as to where in the
code base to look to get started).</p>
<p>An additional useful step can be to tag the corresponding module e.g.
the "GUI/Qt" label when relevant.</p>
</li>
</ol>
<aside class="footnote-list brackets">
<aside class="footnote brackets" id="id2" role="note">
<span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id1">1</a><span class="fn-bracket">]</span></span>
<p>Adapted from the pandas project <a class="reference external" href="https://pandas.pydata.org/docs/development/maintaining.html">maintainers guide</a> and
<a class="reference external" href="https://scikit-learn.org/dev/developers/bug_triaging.html">the scikit-learn project</a> .</p>
</aside>
</aside>
</section>
<section id="working-on-prs-to-help-review">
<h2>Working on PRs to help review<a class="headerlink" href="#working-on-prs-to-help-review" title="Permalink to this heading">#</a></h2>
<p>Reviewing code is also encouraged. Contributors and users are welcome to
participate to the review process following our <a class="reference internal" href="coding_guide.html#pr-guidelines"><span class="std std-ref">review guidelines</span></a>.</p>
</section>
<section id="acknowledgments">
<h2>Acknowledgments<a class="headerlink" href="#acknowledgments" title="Permalink to this heading">#</a></h2>
<p>This page is lightly adapted from <a class="reference external" href="https://scikit-learn.org/dev/developers/bug_triaging.html">the scikit-learn project</a> .</p>
</section>
</section>
</article>
</div>
<div class="bd-sidebar-secondary bd-toc">
<div class="toc-item">
<div class="tocsection onthispage">
<i class="fa-solid fa-list"></i> On this page
</div>
<nav id="bd-toc-nav" class="page-toc">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#working-on-issues-to-improve-them">
Working on issues to improve them
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#triage-team">
Triage team
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#triaging-operations-for-members-of-the-core-and-triage-teams">
Triaging operations for members of the core and triage teams
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#a-typical-workflow-for-triaging-issues">
A typical workflow for triaging issues
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#working-on-prs-to-help-review">
Working on PRs to help review
</a>
</li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#acknowledgments">
Acknowledgments
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="bd-footer-content">
<div class="bd-footer-content__inner">
</div>
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script src="../_static/scripts/bootstrap.js?digest=796348d33e8b1d947c94"></script>
<script src="../_static/scripts/pydata-sphinx-theme.js?digest=796348d33e8b1d947c94"></script>
<footer class="bd-footer"><div class="bd-footer__inner container">
<div class="footer-item">
<p class="copyright">
© Copyright 2002–2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012–2023 The Matplotlib development team.<br>
</p>
</div>
<div class="footer-item">
<p class="sphinx-version">
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 5.3.0.<br>
</p>
</div>
<div class="footer-item">
<p class="sphinx-version">
Built from v3.7.2-2-g4915f574b8.
<br/>
</p>
</div>
</div>
</footer>
</body>
</html>