Skip to content

Commit 2e50b2d

Browse files
story645story645
committed
issue forms + fixed formatting on github
1 parent 739252b commit 2e50b2d

File tree

4 files changed

+195
-0
lines changed

4 files changed

+195
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
name: Bug Report
2+
description: Report a bug or issue with Matplotlib
3+
title: "[Bug]: "
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
To help us understand and resolve your issue, please fill out the form to the best of your ability.
9+
- type: textarea
10+
id: summary
11+
attributes:
12+
label: Bug summary
13+
description: Please provide 1-2 short sentences that succinctly describes the bug
14+
placeholder:
15+
value:
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: reproduction
20+
attributes:
21+
label: Code for reproduction
22+
description: Please provide the minimum code required to reproduce the bug. Please make sure to minimize the number of dependencies required, and provide any necessary plotted data. Avoid using threads, as Matplotlib is (explicitly) not thread-safe.
23+
placeholder: Paste your code here
24+
render: python
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: actual
29+
attributes:
30+
label: Actual outcome
31+
description: Please provide the output produced by the above code, which may be a screenshot, console output, etc.
32+
placeholder: if applicable, paste the console output and images here
33+
validations:
34+
required: true
35+
- type: textarea
36+
id: expected
37+
attributes:
38+
label: Expected outcome
39+
description: Please provide a description (or visual example) of the expected outcome from the code snippet. If this used to work in an earlier version of Matplotlib, please note the version it used to work on
40+
validations:
41+
required: true
42+
- type: input
43+
id: operating-system
44+
attributes:
45+
label: Operating system
46+
description: What operating system are you using?
47+
placeholder: Windows, OS/X, Arch, Debian, Ubuntu, etc.
48+
- type: input
49+
id: matplotlib-version
50+
attributes:
51+
label: Matplotlib Version
52+
placeholder: import matplotlib; print(matplotlib.__version__)
53+
validations:
54+
required: true
55+
- type: input
56+
id: matplotlib-backend
57+
attributes:
58+
label: Matplotlib Backend
59+
placeholder: print(matplotlib.get_backend())
60+
validations:
61+
required: true
62+
- type: input
63+
id: python-version
64+
attributes:
65+
label: Python version
66+
placeholder: python --version
67+
- type: input
68+
id: jupyter-version
69+
attributes:
70+
label: Jupyter version
71+
placeholder: jupyter notebook --version, jupyter lab --version
72+
- type: textarea
73+
id: other-libraries
74+
attributes:
75+
label: Other libraries
76+
description: please provide the versions of any other libraries that are relevant to this bug report.
77+
- type: dropdown
78+
id: install
79+
attributes:
80+
label: Installation
81+
description: how did you install matplotlib?
82+
options:
83+
- pip
84+
- conda
85+
- source
86+
- type: input
87+
id: conda-channel
88+
attributes:
89+
label: Conda channel
90+
description: If you installed from conda, please specify which channel you used if not the default?
91+
placeholder: conda-forge

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Documentation
2+
description: Create a report to help us improve the documentation
3+
title: "[Doc]: "
4+
labels: [Documentation]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
To help us understand and resolve your issue, please fill out the form to the best of your ability.
10+
- type: input
11+
id: link
12+
attributes:
13+
label: Documentation Link
14+
description: Please provide a link to any documentation or examples that you are referencing.
15+
placeholder: https://matplotlib.org/devdocs/
16+
- type: textarea
17+
id: problem
18+
attributes:
19+
label: Problem
20+
description: What is missing, unclear, or wrong in the documentation?
21+
placeholder: |
22+
* I found [...] to be unclear because [...]
23+
* [...] made me think that [...] when really it should be [...]
24+
* There is no example showing how to do [...]
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: improvement
29+
attributes:
30+
label: Suggested improvement
31+
description: How can we improve the documentation?
32+
placeholder: |
33+
* This line should be be changed to say [...]
34+
* Include a paragraph explaining [...]
35+
* Add a figure showing [...]
36+
- type: input
37+
id: matplotlib-version
38+
attributes:
39+
label: Matplotlib Version
40+
placeholder: import matplotlib; print(matplotlib.__version__)
41+
validations:
42+
required: true
43+
- type: input
44+
id: matplotlib-doc-version
45+
attributes:
46+
label: Matplotlib documentation version
47+
placeholder: check under the logo
48+
validations:
49+
required: true
50+
51+

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Feature Request
2+
description: Suggest something to add to Matplotlib!
3+
title: "[ENH]: "
4+
labels: [New feature]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for thinking of a way to improve Matplotlib. Please search the issues for relevant feature requests before creating a new feature request.
10+
- type: textarea
11+
id: problem
12+
attributes:
13+
label: Problem
14+
description: Please provide a clear and concise description of the problem this feature will solve.
15+
placeholder: |
16+
* I'm always frustrated when [...] because [...]
17+
* I would like it if [...] happened when I [...] because [...]
18+
* Here is a sample image of what I am asking for [...]
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: solution
23+
attributes:
24+
label: Proposed solution
25+
description: Please provide a clear and concise description of a way to accomplish what you want.
26+
placeholder: Add an option so that when [...] [...] will happen
27+
- type: textarea
28+
id: prior-art
29+
attributes:
30+
label: Additional context and prior art
31+
description: Add any other context or screenshots about the feature request here. You can also include links to examples of other programs that have something similar to your request.
32+
placeholder: Another project [...] solved this by [...]
33+
34+
35+
36+

‎.github/ISSUE_TEMPLATE/maintenance.yml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Maintenance
2+
description: Help improve performance, usability and/or consistency.
3+
title: "[MNT]: "
4+
labels: [Maintenance]
5+
body:
6+
- type: textarea
7+
id: summary
8+
attributes:
9+
label: Summary
10+
description: Please provide 1-2 short sentences that succinctly describes what could be improved.
11+
validations:
12+
required: true
13+
- type: textarea
14+
id: fix
15+
attributes:
16+
label: Proposed fix
17+
description: Please describe how you think this could be improved.

0 commit comments

Comments
 (0)