From 2713117c51dafa5081d0b88a7d03559b9a9a4bcd Mon Sep 17 00:00:00 2001 From: Maximilian Roos Date: Sun, 12 Sep 2021 12:42:17 -0700 Subject: [PATCH 1/7] Update issue template to include a checklist --- .github/ISSUE_TEMPLATE/bug-report.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 02bc5d0f7b0..cf564298b03 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -27,13 +27,20 @@ Bug reports that follow these guidelines are easier to diagnose, and so are ofte # Put your MCVE code here ``` -**Anything else we need to know?**: - **Environment**:
Output of xr.show_versions() - - +
+ +**Issue checklist** + + + +- [ ] Minimal example — the example is about as small as possible to show the + underlying issue in xarray, and doesn't link to external data. +- [ ] Complete example — the example is self-contained, and includes any traceback. +- [ ] Verifiable example — the example copies & pastes into an IPython prompt. +- [ ] New issue — a cursory search of GitHub Issues suggests this is not a duplicate. From 9c924fb17d5067b6266b1211312ab99f81659c06 Mon Sep 17 00:00:00 2001 From: Maximilian Roos Date: Sun, 12 Sep 2021 17:20:50 -0700 Subject: [PATCH 2/7] --- .github/ISSUE_TEMPLATE/bug-report.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index cf564298b03..778313acaf2 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -14,7 +14,9 @@ Please be concise with code posted. See guidelines below on how to provide a goo - Craft Minimal Bug Reports: http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports - Minimal Complete Verifiable Examples: https://stackoverflow.com/help/mcve -Bug reports that follow these guidelines are easier to diagnose, and so are often handled much more quickly. +While we recognize these take time & effort to create, issues that follow these guidelines are faster +to diagnose, and promote a healthy ecosystem of timely responses to high quality issues. + --> **What happened**: @@ -37,10 +39,12 @@ Bug reports that follow these guidelines are easier to diagnose, and so are ofte **Issue checklist** - + -- [ ] Minimal example — the example is about as small as possible to show the - underlying issue in xarray, and doesn't link to external data. -- [ ] Complete example — the example is self-contained, and includes any traceback. -- [ ] Verifiable example — the example copies & pastes into an IPython prompt. +- [ ] Minimal example — the example is approximately as focused as possible to + demonstrate the underlying issue in xarray. +- [ ] Complete example — the example is self-contained, including all data and + the text of any traceback. +- [ ] Verifiable example — the example copy & pastes into an IPython prompt, returning + the result. - [ ] New issue — a cursory search of GitHub Issues suggests this is not a duplicate. From 586498abbd7828b0eeb0e6d39fe8b945cc708216 Mon Sep 17 00:00:00 2001 From: Maximilian Roos Date: Sun, 12 Sep 2021 18:21:39 -0700 Subject: [PATCH 3/7] --- .github/ISSUE_TEMPLATE/bug-report.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 778313acaf2..90026d35e53 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -7,16 +7,17 @@ assignees: '' --- - **What happened**: @@ -41,10 +42,10 @@ to diagnose, and promote a healthy ecosystem of timely responses to high quality -- [ ] Minimal example — the example is approximately as focused as possible to +- [ ] Minimal example — the example is as focused as reasonably possible to demonstrate the underlying issue in xarray. - [ ] Complete example — the example is self-contained, including all data and the text of any traceback. - [ ] Verifiable example — the example copy & pastes into an IPython prompt, returning the result. -- [ ] New issue — a cursory search of GitHub Issues suggests this is not a duplicate. +- [ ] New issue — a reasonable search of GitHub Issues suggests this is not a duplicate. From 63762d240e1a4b1eec1f1aa0723e59c9cc0b8209 Mon Sep 17 00:00:00 2001 From: Maximilian Roos Date: Tue, 26 Apr 2022 17:23:38 -0700 Subject: [PATCH 4/7] Update issue templates --- .github/ISSUE_TEMPLATE/bug-report.md | 51 --------------------------- .github/ISSUE_TEMPLATE/bugreport.yml | 20 ++++++++--- .github/ISSUE_TEMPLATE/config.yml | 4 +-- .github/ISSUE_TEMPLATE/misc.yml | 4 +-- .github/ISSUE_TEMPLATE/newfeature.yml | 2 +- doc/examples/issue_template.ipynb | 48 +++++++++++++++++++++++++ 6 files changed, 68 insertions(+), 61 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 doc/examples/issue_template.ipynb diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index 90026d35e53..00000000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - - - -**What happened**: - -**What you expected to happen**: - -**Minimal Complete Verifiable Example**: - -```python -# Put your MCVE code here -``` - -**Environment**: - -
Output of xr.show_versions() - - - -
- -**Issue checklist** - - - -- [ ] Minimal example — the example is as focused as reasonably possible to - demonstrate the underlying issue in xarray. -- [ ] Complete example — the example is self-contained, including all data and - the text of any traceback. -- [ ] Verifiable example — the example copy & pastes into an IPython prompt, returning - the result. -- [ ] New issue — a reasonable search of GitHub Issues suggests this is not a duplicate. diff --git a/.github/ISSUE_TEMPLATE/bugreport.yml b/.github/ISSUE_TEMPLATE/bugreport.yml index ba5bc8abaea..bdef5475782 100644 --- a/.github/ISSUE_TEMPLATE/bugreport.yml +++ b/.github/ISSUE_TEMPLATE/bugreport.yml @@ -1,4 +1,4 @@ -name: Bug Report +name: 🐛 Bug Report description: File a bug report to help us improve labels: [bug, "needs triage"] body: @@ -26,14 +26,24 @@ body: attributes: label: Minimal Complete Verifiable Example description: | - Minimal, self-contained copy-pastable example that generates the issue if possible. Please be concise with code posted. See guidelines below on how to provide a good bug report: + Minimal, self-contained copy-pastable example that demonstrates the issue. This will be automatically formatted into code, so no need for markdown backticks. + render: Python + + - type: checkboxes + id: mvce-checkboxes + attributes: + label: MVCE confirmation + description: | + Please confirm that the bug report is in an excellent state, so we can understand & fix it quickly & efficiently. For more details, check out: - [Minimal Complete Verifiable Examples](https://stackoverflow.com/help/mcve) - [Craft Minimal Bug Reports](http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) - Bug reports that follow these guidelines are easier to diagnose, and so are often handled much more quickly. - This will be automatically formatted into code, so no need for markdown backticks. - render: Python + options: + - label: Minimal example — the example is as focused as reasonably possible to demonstrate the underlying issue in xarray. + - label: Complete example — the example is self-contained, including all data and the text of any traceback. + - label: Verifiable example — the example copy & pastes into an IPython prompt or [Binder notebook](https://mybinder.org/v2/gh/pydata/xarray/main?urlpath=lab/tree/doc/examples/issue-template.ipynb), returning the result. + - label: New issue — a search of GitHub Issues suggests this is not a duplicate. - type: textarea id: log-output diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 994c594685d..83e5f3b97fa 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,12 +1,12 @@ blank_issues_enabled: false contact_links: - - name: Usage question + - name: ❓ Usage question url: https://github.com/pydata/xarray/discussions about: | Ask questions and discuss with other community members here. If you have a question like "How do I concatenate a list of datasets?" then please include a self-contained reproducible example if possible. - - name: Raster analysis usage question + - name: 🗺️ Raster analysis usage question url: https://github.com/corteva/rioxarray/discussions about: | If you are using the rioxarray extension (engine='rasterio'), or have questions about diff --git a/.github/ISSUE_TEMPLATE/misc.yml b/.github/ISSUE_TEMPLATE/misc.yml index 94dd2d86567..a98f6d90c45 100644 --- a/.github/ISSUE_TEMPLATE/misc.yml +++ b/.github/ISSUE_TEMPLATE/misc.yml @@ -1,5 +1,5 @@ -name: Issue -description: General Issue or discussion topic. For usage questions, please follow the "Usage question" link +name: 📝 Issue +description: General issue, that's not a bug report. labels: ["needs triage"] body: - type: markdown diff --git a/.github/ISSUE_TEMPLATE/newfeature.yml b/.github/ISSUE_TEMPLATE/newfeature.yml index 77cb15b7d37..04adf4bb867 100644 --- a/.github/ISSUE_TEMPLATE/newfeature.yml +++ b/.github/ISSUE_TEMPLATE/newfeature.yml @@ -1,4 +1,4 @@ -name: Feature Request +name: 💡 Feature Request description: Suggest an idea for xarray labels: [enhancement] body: diff --git a/doc/examples/issue_template.ipynb b/doc/examples/issue_template.ipynb new file mode 100644 index 00000000000..ca92a986c34 --- /dev/null +++ b/doc/examples/issue_template.ipynb @@ -0,0 +1,48 @@ +{ + "cells": [ + { + "cell_type": "code", + "execution_count": null, + "id": "41b90ede", + "metadata": {}, + "outputs": [], + "source": [ + "import xarray as xr\n", + "import numpy as np\n", + "import pandas as pd\n", + "\n", + "ds = xr.tutorial.load_dataset(\"air_temperature\")\n", + "da = ds[\"air\"]" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "effd9aeb", + "metadata": {}, + "outputs": [], + "source": [] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.8.10" + } + }, + "nbformat": 4, + "nbformat_minor": 5 +} From 61b0c49e2f4cc3cbfff2287179ffb7abaff2f246 Mon Sep 17 00:00:00 2001 From: Maximilian Roos Date: Thu, 28 Apr 2022 23:00:46 -0700 Subject: [PATCH 5/7] --- .github/ISSUE_TEMPLATE/bugreport.yml | 2 +- .../{issue_template.ipynb => blank_template.ipynb} | 10 ++++++++++ 2 files changed, 11 insertions(+), 1 deletion(-) rename doc/examples/{issue_template.ipynb => blank_template.ipynb} (80%) diff --git a/.github/ISSUE_TEMPLATE/bugreport.yml b/.github/ISSUE_TEMPLATE/bugreport.yml index bdef5475782..59e5889f5ec 100644 --- a/.github/ISSUE_TEMPLATE/bugreport.yml +++ b/.github/ISSUE_TEMPLATE/bugreport.yml @@ -42,7 +42,7 @@ body: options: - label: Minimal example — the example is as focused as reasonably possible to demonstrate the underlying issue in xarray. - label: Complete example — the example is self-contained, including all data and the text of any traceback. - - label: Verifiable example — the example copy & pastes into an IPython prompt or [Binder notebook](https://mybinder.org/v2/gh/pydata/xarray/main?urlpath=lab/tree/doc/examples/issue-template.ipynb), returning the result. + - label: Verifiable example — the example copy & pastes into an IPython prompt or [Binder notebook](https://mybinder.org/v2/gh/pydata/xarray/main?urlpath=lab/tree/doc/examples/blank_template.ipynb), returning the result. - label: New issue — a search of GitHub Issues suggests this is not a duplicate. - type: textarea diff --git a/doc/examples/issue_template.ipynb b/doc/examples/blank_template.ipynb similarity index 80% rename from doc/examples/issue_template.ipynb rename to doc/examples/blank_template.ipynb index ca92a986c34..bcb15c1158d 100644 --- a/doc/examples/issue_template.ipynb +++ b/doc/examples/blank_template.ipynb @@ -1,5 +1,15 @@ { "cells": [ + { + "cell_type": "markdown", + "id": "d8f54f6a", + "metadata": {}, + "source": [ + "# Blank template\n", + "\n", + "Use this notebook from Binder to test an issue or reproduce a bug report" + ] + }, { "cell_type": "code", "execution_count": null, From 7495daa1b7548acfebd3437578c3c78050dc6f0f Mon Sep 17 00:00:00 2001 From: Maximilian Roos Date: Sat, 30 Apr 2022 10:34:03 -0700 Subject: [PATCH 6/7] --- doc/gallery.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/gallery.rst b/doc/gallery.rst index 36eb39d1a53..fbda843dfce 100644 --- a/doc/gallery.rst +++ b/doc/gallery.rst @@ -93,6 +93,7 @@ Notebook Examples examples/ROMS_ocean_model examples/ERA5-GRIB-example examples/apply_ufunc_vectorize_1d + examples/black_template External Examples From eeb40fee721e9a7dda9f50b2b5d12423842428f1 Mon Sep 17 00:00:00 2001 From: Maximilian Roos Date: Sat, 30 Apr 2022 13:29:00 -0700 Subject: [PATCH 7/7] --- doc/gallery.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/gallery.rst b/doc/gallery.rst index fbda843dfce..22cf0c1c379 100644 --- a/doc/gallery.rst +++ b/doc/gallery.rst @@ -93,7 +93,7 @@ Notebook Examples examples/ROMS_ocean_model examples/ERA5-GRIB-example examples/apply_ufunc_vectorize_1d - examples/black_template + examples/blank_template External Examples