Skip to content

Commit 13b4ef8

Browse files
authored
ADMIN: Add GitHub Issue Forms for Bugs, Performance, or Installation issues (#43411)
* Create Bug Report issue form * Add Installation Issue template * Change to dropdown * Add Performance Issue Form * Fix Typo * Try adding new lines; grammar * Try other newline * Add actual blank line * Fix formatting of bug report template * Remove old bug report template * Address feedback * Single line some examples in install * Improve installation sections after review * Try detail block * Use details block * Use same details block in performance issues
1 parent 343ac2a commit 13b4ef8

File tree

4 files changed

+184
-39
lines changed

4 files changed

+184
-39
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

-39
This file was deleted.
+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
name: Bug Report
2+
description: Report incorrect behavior in the pandas library
3+
title: "BUG: "
4+
labels: [Bug, Needs Triage]
5+
6+
body:
7+
- type: checkboxes
8+
id: checks
9+
attributes:
10+
options:
11+
- label: >
12+
I have checked that this issue has not already been reported.
13+
required: true
14+
- label: >
15+
I have confirmed this bug exists on the
16+
[latest version](https://pandas.pydata.org/docs/whatsnew/index.html) of pandas.
17+
required: true
18+
- label: >
19+
I have confirmed this bug exists on the master branch of pandas.
20+
- type: textarea
21+
id: example
22+
attributes:
23+
label: Reproducible Example
24+
description: >
25+
Please follow [this guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) on how to
26+
provide a minimal, copy-pastable example.
27+
placeholder: >
28+
import pandas as pd
29+
30+
df = pd.DataFrame(range(5))
31+
32+
...
33+
render: python
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: problem
38+
attributes:
39+
label: Issue Description
40+
description: >
41+
Please provide a description of the issue shown in the reproducible example.
42+
validations:
43+
required: true
44+
- type: textarea
45+
id: expected-behavior
46+
attributes:
47+
label: Expected Behavior
48+
description: >
49+
Please describe or show a code example of the expected behavior.
50+
validations:
51+
required: true
52+
- type: textarea
53+
id: version
54+
attributes:
55+
label: Installed Versions
56+
description: >
57+
Please paste the output of ``pd.show_versions()``
58+
value: >
59+
<details>
60+
61+
62+
Replace this line with the output of pd.show_versions()
63+
64+
65+
</details>
66+
validations:
67+
required: true
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
name: Installation Issue
2+
description: Report issues installing the pandas library on your system
3+
title: "BUILD: "
4+
labels: [Build, Needs Triage]
5+
6+
body:
7+
- type: checkboxes
8+
id: checks
9+
attributes:
10+
options:
11+
- label: >
12+
I have read the [installation guide](https://pandas.pydata.org/pandas-docs/stable/getting_started/install.html#installing-pandas).
13+
required: true
14+
- type: input
15+
id: platform
16+
attributes:
17+
label: Platform
18+
description: >
19+
Please provide the output of ``import platform; print(platform.platform())``
20+
validations:
21+
required: true
22+
- type: dropdown
23+
id: method
24+
attributes:
25+
label: Installation Method
26+
description: >
27+
Please provide how you tried to install pandas from a clean environment.
28+
options:
29+
- pip install
30+
- conda install
31+
- apt-get install
32+
- Built from source
33+
- Other
34+
validations:
35+
required: true
36+
- type: input
37+
id: pandas
38+
attributes:
39+
label: pandas Version
40+
description: >
41+
Please provide the version of pandas you are trying to install.
42+
validations:
43+
required: true
44+
- type: input
45+
id: python
46+
attributes:
47+
label: Python Version
48+
description: >
49+
Please provide the installed version of Python.
50+
validations:
51+
required: true
52+
- type: textarea
53+
id: logs
54+
attributes:
55+
label: Installation Logs
56+
description: >
57+
If possible, please copy and paste the installation logs when attempting to install pandas.
58+
value: >
59+
<details>
60+
61+
62+
Replace this line with the installation logs.
63+
64+
65+
</details>
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: Performance Issue
2+
description: Report slow performance or memory issues when running pandas code
3+
title: "PERF: "
4+
labels: [Performance, Needs Triage]
5+
6+
body:
7+
- type: checkboxes
8+
id: checks
9+
attributes:
10+
options:
11+
- label: >
12+
I have checked that this issue has not already been reported.
13+
required: true
14+
- label: >
15+
I have confirmed this issue exists on the
16+
[latest version](https://pandas.pydata.org/docs/whatsnew/index.html) of pandas.
17+
required: true
18+
- label: >
19+
I have confirmed this issue exists on the master branch of pandas.
20+
- type: textarea
21+
id: example
22+
attributes:
23+
label: Reproducible Example
24+
description: >
25+
Please provide a minimal, copy-pastable example that quantifies
26+
[slow runtime](https://docs.python.org/3/library/timeit.html) or
27+
[memory](https://pypi.org/project/memory-profiler/) issues.
28+
validations:
29+
required: true
30+
- type: textarea
31+
id: version
32+
attributes:
33+
label: Installed Versions
34+
description: >
35+
Please paste the output of ``pd.show_versions()``
36+
value: >
37+
<details>
38+
39+
40+
Replace this line with the output of pd.show_versions()
41+
42+
43+
</details>
44+
validations:
45+
required: true
46+
- type: textarea
47+
id: prior-performance
48+
attributes:
49+
label: Prior Performance
50+
description: >
51+
If applicable, please provide the prior version of pandas and output
52+
of the same reproducible example where the performance issue did not exist.

0 commit comments

Comments
 (0)