Skip to content

Commit 2cb95a8

Browse files
authored
Replace markdown issue templates with issue forms (pydata#6119)
1 parent 2957fdf commit 2cb95a8

File tree

4 files changed

+98
-61
lines changed

4 files changed

+98
-61
lines changed

.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 0 additions & 39 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/bugreport.yml

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: Bug Report
2+
description: File a bug report to help us improve
3+
title: '[Bug]: '
4+
labels: [bug, 'needs triage']
5+
assignees: []
6+
body:
7+
- type: textarea
8+
id: what-happened
9+
attributes:
10+
label: What happened?
11+
description: |
12+
Thanks for reporting a bug! Please describe what you were trying to get done.
13+
Tell us what happened, what went wrong.
14+
validations:
15+
required: true
16+
17+
- type: textarea
18+
id: what-did-you-expect-to-happen
19+
attributes:
20+
label: What did you expect to happen?
21+
description: |
22+
Describe what you expected to happen.
23+
validations:
24+
required: false
25+
26+
- type: textarea
27+
id: sample-code
28+
attributes:
29+
label: Minimal Complete Verifiable Example
30+
description: |
31+
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:
32+
33+
- [Minimal Complete Verifiable Examples](https://stackoverflow.com/help/mcve)
34+
- [Craft Minimal Bug Reports](http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports)
35+
36+
Bug reports that follow these guidelines are easier to diagnose, and so are often handled much more quickly.
37+
This will be automatically formatted into code, so no need for markdown backticks.
38+
render: python
39+
40+
- type: textarea
41+
id: log-output
42+
attributes:
43+
label: Relevant log output
44+
description: Please copy and paste any relevant output. This will be automatically formatted into code, so no need for markdown backticks.
45+
render: python
46+
47+
- type: textarea
48+
id: extra
49+
attributes:
50+
label: Anything else we need to know?
51+
description: |
52+
Please describe any other information you want to share.
53+
54+
- type: textarea
55+
id: show-versions
56+
attributes:
57+
label: Environment
58+
description: |
59+
Paste the output of `xr.show_versions()` here
60+
validations:
61+
required: true

.github/ISSUE_TEMPLATE/feature-request.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/newfeature.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Feature Request
2+
description: Suggest an idea for xarray
3+
title: '[FEATURE]: '
4+
labels: [enhancement]
5+
assignees: []
6+
body:
7+
- type: textarea
8+
id: description
9+
attributes:
10+
label: Is your feature request related to a problem?
11+
description: |
12+
Please do a quick search of existing issues to make sure that this has not been asked before.
13+
Please provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
14+
validations:
15+
required: true
16+
- type: textarea
17+
id: solution
18+
attributes:
19+
label: Describe the solution you'd like
20+
description: |
21+
A clear and concise description of what you want to happen.
22+
- type: textarea
23+
id: alternatives
24+
attributes:
25+
label: Describe alternatives you've considered
26+
description: |
27+
A clear and concise description of any alternative solutions or features you've considered.
28+
validations:
29+
required: false
30+
- type: textarea
31+
id: additional-context
32+
attributes:
33+
label: Additional context
34+
description: |
35+
Add any other context about the feature request here.
36+
validations:
37+
required: false

0 commit comments

Comments
 (0)