Skip to content

Commit

Permalink
Update issue template to include a checklist (pydata#6522)
Browse files Browse the repository at this point in the history
* Update issue template to include a checklist

* Update issue templates
  • Loading branch information
max-sixty committed May 1, 2022
1 parent c003dea commit 6144c61
Show file tree
Hide file tree
Showing 6 changed files with 79 additions and 10 deletions.
20 changes: 15 additions & 5 deletions .github/ISSUE_TEMPLATE/bugreport.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Bug Report
name: 🐛 Bug Report
description: File a bug report to help us improve
labels: [bug, "needs triage"]
body:
Expand Down Expand Up @@ -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/blank_template.ipynb), returning the result.
- label: New issue — a search of GitHub Issues suggests this is not a duplicate.

- type: textarea
id: log-output
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/misc.yml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/newfeature.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Feature Request
name: 💡 Feature Request
description: Suggest an idea for xarray
labels: [enhancement]
body:
Expand Down
58 changes: 58 additions & 0 deletions doc/examples/blank_template.ipynb
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
{
"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,
"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
}
1 change: 1 addition & 0 deletions doc/gallery.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ Notebook Examples
examples/ROMS_ocean_model
examples/ERA5-GRIB-example
examples/apply_ufunc_vectorize_1d
examples/blank_template


External Examples
Expand Down

0 comments on commit 6144c61

Please sign in to comment.