Skip to content

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
merged 16 commits into from
Sep 6, 2021
Merged
39 changes: 0 additions & 39 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
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:
required: true
61 changes: 61 additions & 0 deletions .github/ISSUE_TEMPLATE/installation_issue.yaml
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)
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
validations:
required: true
- type: input
id: python
attributes:
label: Python Version
description: >
Please provide the installed version of Python.
validations:
required: true
- type: textarea
id: logs
attributes:
label: Installation Logs
description: >
If possible, please copy and paste the installation logs when attempting to install pandas.
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/performance_issue.yaml
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.