From 6c4b80a0c6b9a17830e7a665c31dc534a586040a Mon Sep 17 00:00:00 2001 From: Matthew Roeschke Date: Sat, 4 Sep 2021 18:45:57 -0700 Subject: [PATCH 01/16] Create Bug Report issue form --- .github/ISSUE_TEMPLATE/bug_report.yaml | 56 ++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 0000000000000..32b0733942431 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,56 @@ +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 copy-pastable example that can be run on a Python REPL. + placeholder: > + import pandas as pd + df = pd.DataFrame(range(5)) + ... + validations: + required: true + - type: textarea + id: problem + attributes: + label: Issue Description + description: > + Please provide a description of the issue with 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()`` + validations: + required: true From 0b5eb50dbc21dc1622e8e4afb999b15506d27a8a Mon Sep 17 00:00:00 2001 From: Matthew Roeschke Date: Sat, 4 Sep 2021 19:17:29 -0700 Subject: [PATCH 02/16] Add Installation Issue template --- .github/ISSUE_TEMPLATE/bug_report.yaml | 2 +- .../ISSUE_TEMPLATE/installation_issue.yaml | 63 +++++++++++++++++++ 2 files changed, 64 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/installation_issue.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 32b0733942431..1837bcee05bd2 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -1,6 +1,6 @@ name: Bug Report description: Report incorrect behavior in the pandas library -title: "Bug: " +title: "BUG: " labels: [Bug, Needs Triage] body: diff --git a/.github/ISSUE_TEMPLATE/installation_issue.yaml b/.github/ISSUE_TEMPLATE/installation_issue.yaml new file mode 100644 index 0000000000000..4b485fabc1df5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/installation_issue.yaml @@ -0,0 +1,63 @@ +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: textarea + id: operating-system + attributes: + label: Operating System + descrption: > + Please provide the operating system are you running. + placeholder: > + Windows 10 + macOS 11 Big Sur + Ubuntu 18.04 LTS + validations: + required: true + - type: textarea + id: platform + attributes: + label: Platform + description: > + Please provide the hardware platform are you running. + placeholder: > + x86-64 + ARM64 (M1) + validations: + required: true + - type: textarea + id: method + attributes: + label: Installation Method + description: > + Please describe how you tried to install pandas + placeholder: > + pip install + conda install + apt-get install + Built from source + validations: + required: true + - type: textarea + 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. From 7004e5e2b4f7bb11a523ccd88cb22fe6821be673 Mon Sep 17 00:00:00 2001 From: Matthew Roeschke Date: Sat, 4 Sep 2021 19:23:35 -0700 Subject: [PATCH 03/16] Change to dropdown --- .github/ISSUE_TEMPLATE/installation_issue.yaml | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/installation_issue.yaml b/.github/ISSUE_TEMPLATE/installation_issue.yaml index 4b485fabc1df5..d3bf6ef6f7b6a 100644 --- a/.github/ISSUE_TEMPLATE/installation_issue.yaml +++ b/.github/ISSUE_TEMPLATE/installation_issue.yaml @@ -34,17 +34,18 @@ body: ARM64 (M1) validations: required: true - - type: textarea + - type: dropdown id: method attributes: label: Installation Method description: > - Please describe how you tried to install pandas - placeholder: > - pip install - conda install - apt-get install - Built from source + Please provide how you tried to install pandas. + options: + - pip install + - conda install + - apt-get install + - Built from source + - Other validations: required: true - type: textarea From fba15d92f43bce1469627e7d982971380f275e86 Mon Sep 17 00:00:00 2001 From: Matthew Roeschke Date: Sat, 4 Sep 2021 20:30:22 -0700 Subject: [PATCH 04/16] Add Performance Issue Form --- .github/ISSUE_TEMPLATE/performance_issue.yaml | 44 +++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/performance_issue.yaml diff --git a/.github/ISSUE_TEMPLATE/performance_issue.yaml b/.github/ISSUE_TEMPLATE/performance_issue.yaml new file mode 100644 index 0000000000000..d96c0b849e73d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/performance_issue.yaml @@ -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. From 5c009cf7d5203c2f09de95cb63ea998c0972f93d Mon Sep 17 00:00:00 2001 From: Matthew Roeschke Date: Sat, 4 Sep 2021 20:40:45 -0700 Subject: [PATCH 05/16] Fix Typo --- .github/ISSUE_TEMPLATE/installation_issue.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/installation_issue.yaml b/.github/ISSUE_TEMPLATE/installation_issue.yaml index d3bf6ef6f7b6a..98ba0fa195a3c 100644 --- a/.github/ISSUE_TEMPLATE/installation_issue.yaml +++ b/.github/ISSUE_TEMPLATE/installation_issue.yaml @@ -15,7 +15,7 @@ body: id: operating-system attributes: label: Operating System - descrption: > + description: > Please provide the operating system are you running. placeholder: > Windows 10 From ed7c4f16bcd723af1f118083455fdbbb4d6b9881 Mon Sep 17 00:00:00 2001 From: Matthew Roeschke Date: Sat, 4 Sep 2021 20:43:12 -0700 Subject: [PATCH 06/16] Try adding new lines; grammar --- .github/ISSUE_TEMPLATE/installation_issue.yaml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/installation_issue.yaml b/.github/ISSUE_TEMPLATE/installation_issue.yaml index 98ba0fa195a3c..5c59f9d6c8d5d 100644 --- a/.github/ISSUE_TEMPLATE/installation_issue.yaml +++ b/.github/ISSUE_TEMPLATE/installation_issue.yaml @@ -16,10 +16,10 @@ body: attributes: label: Operating System description: > - Please provide the operating system are you running. + Please provide the operating system you are running. placeholder: > - Windows 10 - macOS 11 Big Sur + Windows 10 \n + macOS 11 Big Sur \n Ubuntu 18.04 LTS validations: required: true @@ -28,9 +28,9 @@ body: attributes: label: Platform description: > - Please provide the hardware platform are you running. + Please provide the hardware platform you are running. placeholder: > - x86-64 + x86-64 \n ARM64 (M1) validations: required: true From 6c34b6e4d2f60d2d9b39838e0c1a7ba9f3931627 Mon Sep 17 00:00:00 2001 From: Matthew Roeschke Date: Sat, 4 Sep 2021 20:44:11 -0700 Subject: [PATCH 07/16] Try other newline --- .github/ISSUE_TEMPLATE/installation_issue.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/installation_issue.yaml b/.github/ISSUE_TEMPLATE/installation_issue.yaml index 5c59f9d6c8d5d..2507eef8fddcb 100644 --- a/.github/ISSUE_TEMPLATE/installation_issue.yaml +++ b/.github/ISSUE_TEMPLATE/installation_issue.yaml @@ -18,8 +18,8 @@ body: description: > Please provide the operating system you are running. placeholder: > - Windows 10 \n - macOS 11 Big Sur \n + Windows 10 > + macOS 11 Big Sur > Ubuntu 18.04 LTS validations: required: true @@ -30,7 +30,7 @@ body: description: > Please provide the hardware platform you are running. placeholder: > - x86-64 \n + x86-64 > ARM64 (M1) validations: required: true From 8e58cf20b9e2b76058b65cdd87d30694bd41da3e Mon Sep 17 00:00:00 2001 From: Matthew Roeschke Date: Sat, 4 Sep 2021 20:47:04 -0700 Subject: [PATCH 08/16] Add actual blank line --- .github/ISSUE_TEMPLATE/installation_issue.yaml | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/installation_issue.yaml b/.github/ISSUE_TEMPLATE/installation_issue.yaml index 2507eef8fddcb..d04ac8c6a89ba 100644 --- a/.github/ISSUE_TEMPLATE/installation_issue.yaml +++ b/.github/ISSUE_TEMPLATE/installation_issue.yaml @@ -18,8 +18,10 @@ body: description: > Please provide the operating system you are running. placeholder: > - Windows 10 > - macOS 11 Big Sur > + Windows 10 + + macOS 11 Big Sur + Ubuntu 18.04 LTS validations: required: true @@ -30,7 +32,8 @@ body: description: > Please provide the hardware platform you are running. placeholder: > - x86-64 > + x86-64 + ARM64 (M1) validations: required: true From 4022366df869c5bd2f2ff7cd265131825e07c084 Mon Sep 17 00:00:00 2001 From: Matthew Roeschke Date: Sat, 4 Sep 2021 20:52:37 -0700 Subject: [PATCH 09/16] Fix formatting of bug report template --- .github/ISSUE_TEMPLATE/bug_report.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 1837bcee05bd2..475f3bd33e137 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -26,7 +26,9 @@ body: provide a copy-pastable example that can be run on a Python REPL. placeholder: > import pandas as pd + df = pd.DataFrame(range(5)) + ... validations: required: true From b5c1f809df6f489188aad94e1d712ce9105cd39c Mon Sep 17 00:00:00 2001 From: Matthew Roeschke Date: Sat, 4 Sep 2021 20:53:03 -0700 Subject: [PATCH 10/16] Remove old bug report template --- .github/ISSUE_TEMPLATE/bug_report.md | 39 ---------------------------- 1 file changed, 39 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 765c1b8bff62e..0000000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,39 +0,0 @@ ---- - -name: Bug Report -about: Create a bug report to help us improve pandas -title: "BUG:" -labels: "Bug, Needs Triage" - ---- - -- [ ] I have checked that this issue has not already been reported. - -- [ ] I have confirmed this bug exists on the latest version of pandas. - -- [ ] (optional) I have confirmed this bug exists on the master branch of pandas. - ---- - -**Note**: Please read [this guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) detailing how to provide the necessary information for us to reproduce your bug. - -#### Code Sample, a copy-pastable example - -```python -# Your code here - -``` - -#### Problem description - -[this should explain **why** the current behaviour is a problem and why the expected output is a better solution] - -#### Expected Output - -#### Output of ``pd.show_versions()`` - -
- -[paste the output of ``pd.show_versions()`` here leaving a blank line after the details tag] - -
From 20a73e5995118a57e0d2ecb265109ae300cf4edc Mon Sep 17 00:00:00 2001 From: Matthew Roeschke Date: Sat, 4 Sep 2021 23:26:06 -0700 Subject: [PATCH 11/16] Address feedback --- .github/ISSUE_TEMPLATE/bug_report.yaml | 6 ++++-- .github/ISSUE_TEMPLATE/installation_issue.yaml | 8 ++++---- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 475f3bd33e137..78b316e009bce 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -23,13 +23,14 @@ body: label: Reproducible Example description: > Please follow [this guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) on how to - provide a copy-pastable example that can be run on a Python REPL. + provide a minimal, copy-pastable example. placeholder: > import pandas as pd df = pd.DataFrame(range(5)) ... + render: python validations: required: true - type: textarea @@ -37,7 +38,7 @@ body: attributes: label: Issue Description description: > - Please provide a description of the issue with the reproducible example. + Please provide a description of the issue shown in the reproducible example. validations: required: true - type: textarea @@ -54,5 +55,6 @@ body: label: Installed Versions description: > Please paste the output of ``pd.show_versions()`` + render: shell validations: required: true diff --git a/.github/ISSUE_TEMPLATE/installation_issue.yaml b/.github/ISSUE_TEMPLATE/installation_issue.yaml index d04ac8c6a89ba..52a34812eaf76 100644 --- a/.github/ISSUE_TEMPLATE/installation_issue.yaml +++ b/.github/ISSUE_TEMPLATE/installation_issue.yaml @@ -11,7 +11,7 @@ body: - label: > I have read the [installation guide](https://pandas.pydata.org/pandas-docs/stable/getting_started/install.html#installing-pandas). required: true - - type: textarea + - type: input id: operating-system attributes: label: Operating System @@ -25,7 +25,7 @@ body: Ubuntu 18.04 LTS validations: required: true - - type: textarea + - type: input id: platform attributes: label: Platform @@ -42,7 +42,7 @@ body: attributes: label: Installation Method description: > - Please provide how you tried to install pandas. + Please provide how you tried to install pandas from a clean environment. options: - pip install - conda install @@ -51,7 +51,7 @@ body: - Other validations: required: true - - type: textarea + - type: input id: python attributes: label: Python Version From 09ecec6dac472b3bf1dea0473d627dceca28733f Mon Sep 17 00:00:00 2001 From: Matthew Roeschke Date: Sat, 4 Sep 2021 23:28:59 -0700 Subject: [PATCH 12/16] Single line some examples in install --- .github/ISSUE_TEMPLATE/installation_issue.yaml | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/installation_issue.yaml b/.github/ISSUE_TEMPLATE/installation_issue.yaml index 52a34812eaf76..b2c7b4ebc92be 100644 --- a/.github/ISSUE_TEMPLATE/installation_issue.yaml +++ b/.github/ISSUE_TEMPLATE/installation_issue.yaml @@ -18,11 +18,7 @@ body: description: > Please provide the operating system you are running. placeholder: > - Windows 10 - - macOS 11 Big Sur - - Ubuntu 18.04 LTS + e.g. Windows 10, macOS 11 Big Sur, Ubuntu 18.04 LTS validations: required: true - type: input @@ -32,9 +28,7 @@ body: description: > Please provide the hardware platform you are running. placeholder: > - x86-64 - - ARM64 (M1) + e.g. x86-64, ARM64 (M1) validations: required: true - type: dropdown From 9085d7e77f061671917ba5219c88c8cfd6a3e3b8 Mon Sep 17 00:00:00 2001 From: Matthew Roeschke Date: Sun, 5 Sep 2021 11:20:34 -0700 Subject: [PATCH 13/16] Improve installation sections after review --- .../ISSUE_TEMPLATE/installation_issue.yaml | 22 ++++++++----------- 1 file changed, 9 insertions(+), 13 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/installation_issue.yaml b/.github/ISSUE_TEMPLATE/installation_issue.yaml index b2c7b4ebc92be..11529b2f40b57 100644 --- a/.github/ISSUE_TEMPLATE/installation_issue.yaml +++ b/.github/ISSUE_TEMPLATE/installation_issue.yaml @@ -11,24 +11,12 @@ body: - 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) + Please provide the output of ``import platform; print(platform.platform())`` validations: required: true - type: dropdown @@ -45,6 +33,14 @@ body: - Other validations: required: true + - type: input + id: pandas + attributes: + label: pandas Version + description: > + Please provide the version of pandas you are trying to install. + validations: + required: true - type: input id: python attributes: From 5204cf4d91ccf50e3a8ebb154ae430fa58582980 Mon Sep 17 00:00:00 2001 From: Matthew Roeschke Date: Sun, 5 Sep 2021 11:33:51 -0700 Subject: [PATCH 14/16] Try detail block --- .github/ISSUE_TEMPLATE/bug_report.yaml | 8 +++++++- .github/ISSUE_TEMPLATE/installation_issue.yaml | 7 +++++++ 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 78b316e009bce..d832756868ecd 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -55,6 +55,12 @@ body: label: Installed Versions description: > Please paste the output of ``pd.show_versions()`` - render: shell + value: > +
+ + Replace this line with the output of pd.show_versions() + +
+ render: html validations: required: true diff --git a/.github/ISSUE_TEMPLATE/installation_issue.yaml b/.github/ISSUE_TEMPLATE/installation_issue.yaml index 11529b2f40b57..805106bc5cb54 100644 --- a/.github/ISSUE_TEMPLATE/installation_issue.yaml +++ b/.github/ISSUE_TEMPLATE/installation_issue.yaml @@ -55,3 +55,10 @@ body: label: Installation Logs description: > If possible, please copy and paste the installation logs when attempting to install pandas. + value: > +
+ + Replace this line with the installation logs. + +
+ render: html From a53084cb202b99c7abbc8144fae138cd8dae9f9b Mon Sep 17 00:00:00 2001 From: Matthew Roeschke Date: Sun, 5 Sep 2021 11:46:54 -0700 Subject: [PATCH 15/16] Use details block --- .github/ISSUE_TEMPLATE/bug_report.yaml | 3 ++- .github/ISSUE_TEMPLATE/installation_issue.yaml | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index d832756868ecd..0f50eb47607cd 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -58,9 +58,10 @@ body: value: >
+ Replace this line with the output of pd.show_versions() +
- render: html validations: required: true diff --git a/.github/ISSUE_TEMPLATE/installation_issue.yaml b/.github/ISSUE_TEMPLATE/installation_issue.yaml index 805106bc5cb54..d5db0d1c83a41 100644 --- a/.github/ISSUE_TEMPLATE/installation_issue.yaml +++ b/.github/ISSUE_TEMPLATE/installation_issue.yaml @@ -58,7 +58,8 @@ body: value: >
+ Replace this line with the installation logs. +
- render: html From 5aecb888aeb5c3b5e5aa709b0cb7a0d4c4d2a27d Mon Sep 17 00:00:00 2001 From: Matthew Roeschke Date: Sun, 5 Sep 2021 11:49:05 -0700 Subject: [PATCH 16/16] Use same details block in performance issues --- .github/ISSUE_TEMPLATE/performance_issue.yaml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/performance_issue.yaml b/.github/ISSUE_TEMPLATE/performance_issue.yaml index d96c0b849e73d..2dcfc94f4a604 100644 --- a/.github/ISSUE_TEMPLATE/performance_issue.yaml +++ b/.github/ISSUE_TEMPLATE/performance_issue.yaml @@ -33,6 +33,14 @@ body: label: Installed Versions description: > Please paste the output of ``pd.show_versions()`` + value: > +
+ + + Replace this line with the output of pd.show_versions() + + +
validations: required: true - type: textarea