Skip to content

Commit bc4640c

Browse files
authored
MNT: Add issue-forms with YAML instead of Markdown (#232)
1 parent e359dd2 commit bc4640c

File tree

4 files changed

+119
-73
lines changed

4 files changed

+119
-73
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 53 deletions
This file was deleted.
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
name: 🐛 Bug report
2+
3+
# See the json schema to help you create / update this form
4+
# https://json.schemastore.org/github-issue-forms.json
5+
6+
description: Create a report to help us improve
7+
8+
labels: ["BUG"]
9+
10+
body:
11+
12+
- type: markdown
13+
attributes:
14+
value: |
15+
**READ THIS FIRST:** If you are having trouble getting MNE-Python to work with
16+
your own data, you should ask for help on the
17+
[MNE Forum](https://mne.discourse.group).
18+
19+
Our GitHub issue tracker is only used to report bugs and suggest improvements
20+
to MNE-Python. For any other questions, please use the forum.
21+
Usage questions that are posted as GitHub issues are usually closed without
22+
being answered. See
23+
[the FAQ entry on filing bug reports](https://mne.tools/dev/overview/faq.html#i-think-i-found-a-bug-what-do-i-do)
24+
for more guidance. If you're pretty sure your problem is a bug in MNE-Python,
25+
please **delete this section** and fill in the headings below, replacing the
26+
placeholder text with your own responses. Surround any code samples with triple
27+
backticks above and below the code block (see
28+
[the GitHub guide to markdown](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown)
29+
for help with issue formatting). Alternatively, you can put your MWE in a
30+
[public gist](https://gist.github.com) and link to it in this issue.
31+
32+
- type: textarea
33+
attributes:
34+
label: Description of the problem
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
attributes:
40+
label: Steps to reproduce
41+
description: |
42+
Paste here a code snippet or minimal working example
43+
([MWE](https://en.wikipedia.org/wiki/Minimal_Working_Example))
44+
to replicate your problem, using one of the
45+
[datasets shipped with MNE-Python](https://mne.tools/dev/overview/datasets_index.html),
46+
preferably the one called [sample](https://mne.tools/dev/overview/datasets_index.html#sample).
47+
render: Python
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
attributes:
53+
label: Expected results
54+
validations:
55+
required: true
56+
57+
- type: textarea
58+
attributes:
59+
label: Actual results
60+
description: |
61+
Please provide the actual output, traceback, screenshot, or another description of the results.
62+
validations:
63+
required: true
64+
65+
- type: textarea
66+
attributes:
67+
label: Additional information
68+
description: |
69+
Tell us about your system: paste the output of `mne.sys_info()` here.
70+
validations:
71+
required: true

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 20 deletions
This file was deleted.
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: 🛠️ Feature request
2+
3+
# See the json schema to help you create / update this form
4+
# https://json.schemastore.org/github-issue-forms.json
5+
6+
description: Suggest an idea for this project
7+
8+
labels: ["enhancement"]
9+
10+
body:
11+
12+
- type: markdown
13+
attributes:
14+
value: |
15+
Please use the [MNE-Python forum](https://mne.discourse.group/) to ask (and answer)
16+
concrete technical questions or about usage of MNE-BIDS.
17+
Use this form if you want to suggest new features.
18+
19+
- type: textarea
20+
attributes:
21+
label: Describe the problem
22+
description: |
23+
Please provide a clear and concise description of the problem.
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
attributes:
29+
label: Describe your solution
30+
description: |
31+
A clear and concise description of what you want to happen.
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
attributes:
37+
label: Describe possible alternatives
38+
description: |
39+
A clear and concise description of any alternative solutions or features you have considered.
40+
validations:
41+
required: true
42+
43+
44+
- type: textarea
45+
attributes:
46+
label: Additional context
47+
description: |
48+
Add any other context or screenshots about the feature request here.

0 commit comments

Comments
 (0)