Skip to content

Commit 6144c61

Browse files
authored
Update issue template to include a checklist (pydata#6522)
* Update issue template to include a checklist * Update issue templates
1 parent c003dea commit 6144c61

File tree

6 files changed

+79
-10
lines changed

6 files changed

+79
-10
lines changed

.github/ISSUE_TEMPLATE/bugreport.yml

+15-5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Bug Report
1+
name: 🐛 Bug Report
22
description: File a bug report to help us improve
33
labels: [bug, "needs triage"]
44
body:
@@ -26,14 +26,24 @@ body:
2626
attributes:
2727
label: Minimal Complete Verifiable Example
2828
description: |
29-
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:
29+
Minimal, self-contained copy-pastable example that demonstrates the issue. This will be automatically formatted into code, so no need for markdown backticks.
30+
render: Python
31+
32+
- type: checkboxes
33+
id: mvce-checkboxes
34+
attributes:
35+
label: MVCE confirmation
36+
description: |
37+
Please confirm that the bug report is in an excellent state, so we can understand & fix it quickly & efficiently. For more details, check out:
3038
3139
- [Minimal Complete Verifiable Examples](https://stackoverflow.com/help/mcve)
3240
- [Craft Minimal Bug Reports](http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports)
3341
34-
Bug reports that follow these guidelines are easier to diagnose, and so are often handled much more quickly.
35-
This will be automatically formatted into code, so no need for markdown backticks.
36-
render: Python
42+
options:
43+
- label: Minimal example — the example is as focused as reasonably possible to demonstrate the underlying issue in xarray.
44+
- label: Complete example — the example is self-contained, including all data and the text of any traceback.
45+
- 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.
46+
- label: New issue — a search of GitHub Issues suggests this is not a duplicate.
3747

3848
- type: textarea
3949
id: log-output

.github/ISSUE_TEMPLATE/config.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
blank_issues_enabled: false
22
contact_links:
3-
- name: Usage question
3+
- name: Usage question
44
url: https://github.com/pydata/xarray/discussions
55
about: |
66
Ask questions and discuss with other community members here.
77
If you have a question like "How do I concatenate a list of datasets?" then
88
please include a self-contained reproducible example if possible.
9-
- name: Raster analysis usage question
9+
- name: 🗺️ Raster analysis usage question
1010
url: https://github.com/corteva/rioxarray/discussions
1111
about: |
1212
If you are using the rioxarray extension (engine='rasterio'), or have questions about

.github/ISSUE_TEMPLATE/misc.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
name: Issue
2-
description: General Issue or discussion topic. For usage questions, please follow the "Usage question" link
1+
name: 📝 Issue
2+
description: General issue, that's not a bug report.
33
labels: ["needs triage"]
44
body:
55
- type: markdown

.github/ISSUE_TEMPLATE/newfeature.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Feature Request
1+
name: 💡 Feature Request
22
description: Suggest an idea for xarray
33
labels: [enhancement]
44
body:

doc/examples/blank_template.ipynb

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
{
2+
"cells": [
3+
{
4+
"cell_type": "markdown",
5+
"id": "d8f54f6a",
6+
"metadata": {},
7+
"source": [
8+
"# Blank template\n",
9+
"\n",
10+
"Use this notebook from Binder to test an issue or reproduce a bug report"
11+
]
12+
},
13+
{
14+
"cell_type": "code",
15+
"execution_count": null,
16+
"id": "41b90ede",
17+
"metadata": {},
18+
"outputs": [],
19+
"source": [
20+
"import xarray as xr\n",
21+
"import numpy as np\n",
22+
"import pandas as pd\n",
23+
"\n",
24+
"ds = xr.tutorial.load_dataset(\"air_temperature\")\n",
25+
"da = ds[\"air\"]"
26+
]
27+
},
28+
{
29+
"cell_type": "code",
30+
"execution_count": null,
31+
"id": "effd9aeb",
32+
"metadata": {},
33+
"outputs": [],
34+
"source": []
35+
}
36+
],
37+
"metadata": {
38+
"kernelspec": {
39+
"display_name": "Python 3",
40+
"language": "python",
41+
"name": "python3"
42+
},
43+
"language_info": {
44+
"codemirror_mode": {
45+
"name": "ipython",
46+
"version": 3
47+
},
48+
"file_extension": ".py",
49+
"mimetype": "text/x-python",
50+
"name": "python",
51+
"nbconvert_exporter": "python",
52+
"pygments_lexer": "ipython3",
53+
"version": "3.8.10"
54+
}
55+
},
56+
"nbformat": 4,
57+
"nbformat_minor": 5
58+
}

doc/gallery.rst

+1
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,7 @@ Notebook Examples
9393
examples/ROMS_ocean_model
9494
examples/ERA5-GRIB-example
9595
examples/apply_ufunc_vectorize_1d
96+
examples/blank_template
9697

9798

9899
External Examples

0 commit comments

Comments
 (0)