-
-
Notifications
You must be signed in to change notification settings - Fork 18.5k
ADMIN: Add GitHub Issue Forms for Bugs, Performance, or Installation issues #43411
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
mroeschke
merged 16 commits into
pandas-dev:master
from
mroeschke:enh/bug_and_perf_template
Sep 6, 2021
Merged
Changes from 12 commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
6c4b80a
Create Bug Report issue form
mroeschke 0b5eb50
Add Installation Issue template
mroeschke 7004e5e
Change to dropdown
mroeschke fba15d9
Add Performance Issue Form
mroeschke 5c009cf
Fix Typo
mroeschke ed7c4f1
Try adding new lines; grammar
mroeschke 6c34b6e
Try other newline
mroeschke 8e58cf2
Add actual blank line
mroeschke 4022366
Fix formatting of bug report template
mroeschke b5c1f80
Remove old bug report template
mroeschke 20a73e5
Address feedback
mroeschke 09ecec6
Single line some examples in install
mroeschke 9085d7e
Improve installation sections after review
mroeschke 5204cf4
Try detail block
mroeschke a53084c
Use details block
mroeschke 5aecb88
Use same details block in performance issues
mroeschke File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
name: Bug Report | ||
description: Report incorrect behavior in the pandas library | ||
title: "BUG: " | ||
labels: [Bug, Needs Triage] | ||
|
||
body: | ||
- type: checkboxes | ||
id: checks | ||
attributes: | ||
options: | ||
- label: > | ||
I have checked that this issue has not already been reported. | ||
required: true | ||
- label: > | ||
I have confirmed this bug exists on the | ||
[latest version](https://pandas.pydata.org/docs/whatsnew/index.html) of pandas. | ||
required: true | ||
- label: > | ||
I have confirmed this bug exists on the master branch of pandas. | ||
- type: textarea | ||
id: example | ||
attributes: | ||
label: Reproducible Example | ||
description: > | ||
Please follow [this guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) on how to | ||
provide a minimal, copy-pastable example. | ||
placeholder: > | ||
import pandas as pd | ||
|
||
df = pd.DataFrame(range(5)) | ||
|
||
... | ||
render: python | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: problem | ||
attributes: | ||
label: Issue Description | ||
description: > | ||
Please provide a description of the issue shown in the reproducible example. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: expected-behavior | ||
attributes: | ||
label: Expected Behavior | ||
description: > | ||
Please describe or show a code example of the expected behavior. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: version | ||
attributes: | ||
label: Installed Versions | ||
description: > | ||
Please paste the output of ``pd.show_versions()`` | ||
render: shell | ||
validations: | ||
mzeitlin11 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
required: true |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
name: Installation Issue | ||
description: Report issues installing the pandas library on your system | ||
title: "BUILD: " | ||
labels: [Build, Needs Triage] | ||
|
||
body: | ||
- type: checkboxes | ||
id: checks | ||
attributes: | ||
options: | ||
- label: > | ||
I have read the [installation guide](https://pandas.pydata.org/pandas-docs/stable/getting_started/install.html#installing-pandas). | ||
required: true | ||
- type: input | ||
id: operating-system | ||
attributes: | ||
label: Operating System | ||
description: > | ||
Please provide the operating system you are running. | ||
placeholder: > | ||
e.g. Windows 10, macOS 11 Big Sur, Ubuntu 18.04 LTS | ||
validations: | ||
required: true | ||
- type: input | ||
id: platform | ||
attributes: | ||
label: Platform | ||
description: > | ||
Please provide the hardware platform you are running. | ||
placeholder: > | ||
e.g. x86-64, ARM64 (M1) | ||
lithomas1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
validations: | ||
required: true | ||
- type: dropdown | ||
id: method | ||
attributes: | ||
label: Installation Method | ||
description: > | ||
Please provide how you tried to install pandas from a clean environment. | ||
options: | ||
- pip install | ||
- conda install | ||
- apt-get install | ||
- Built from source | ||
- Other | ||
mzeitlin11 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
validations: | ||
required: true | ||
- type: input | ||
id: python | ||
attributes: | ||
label: Python Version | ||
lithomas1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
description: > | ||
Please provide the installed version of Python. | ||
validations: | ||
required: true | ||
mzeitlin11 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- type: textarea | ||
id: logs | ||
attributes: | ||
label: Installation Logs | ||
description: > | ||
If possible, please copy and paste the installation logs when attempting to install pandas. | ||
mzeitlin11 marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
name: Performance Issue | ||
description: Report slow performance or memory issues when running pandas code | ||
title: "PERF: " | ||
labels: [Performance, Needs Triage] | ||
|
||
body: | ||
- type: checkboxes | ||
id: checks | ||
attributes: | ||
options: | ||
- label: > | ||
I have checked that this issue has not already been reported. | ||
required: true | ||
- label: > | ||
I have confirmed this issue exists on the | ||
[latest version](https://pandas.pydata.org/docs/whatsnew/index.html) of pandas. | ||
required: true | ||
- label: > | ||
I have confirmed this issue exists on the master branch of pandas. | ||
- type: textarea | ||
id: example | ||
attributes: | ||
label: Reproducible Example | ||
description: > | ||
Please provide a minimal, copy-pastable example that quantifies | ||
[slow runtime](https://docs.python.org/3/library/timeit.html) or | ||
[memory](https://pypi.org/project/memory-profiler/) issues. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: version | ||
attributes: | ||
label: Installed Versions | ||
description: > | ||
Please paste the output of ``pd.show_versions()`` | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: prior-performance | ||
attributes: | ||
label: Prior Performance | ||
description: > | ||
If applicable, please provide the prior version of pandas and output | ||
of the same reproducible example where the performance issue did not exist. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.