Skip to content

Commit

Permalink
[MRG] MAINT: Use new GitHub issue forms (yml) (#1056)
Browse files Browse the repository at this point in the history
* use new issue forms

* add emojis, remove title prefix [skip ci]

Co-authored-by: Richard Höchenberger <[email protected]>
  • Loading branch information
sappelhoff and hoechenberger authored Aug 27, 2022
1 parent 3f77995 commit 43b77c9
Show file tree
Hide file tree
Showing 6 changed files with 103 additions and 59 deletions.
4 changes: 3 additions & 1 deletion .github/ISSUE_TEMPLATE/blank.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
name: Blank issue
about: Create an issue without a template.

title: ''
labels: ''
assignees: ''
---
35 changes: 0 additions & 35 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Bug report

# See the json schema to help you create / update this form
# https://json.schemastore.org/github-issue-forms.json

description: 🐛 Create a report to help us improve

labels: ["bug"]

body:

- type: markdown
attributes:
value: |
Please use the [MNE-Python forum](https://mne.discourse.group/) to ask (and answer)
concrete technical questions or about usage of MNE-BIDS.
Use this form if you have experienced bugs.
- type: textarea
attributes:
label: Description of the problem

- type: textarea
attributes:
label: Steps to reproduce
description: |
Replace this text with a code snippet or minimal working example
([MWE](https://en.wikipedia.org/wiki/Minimal_Working_Example))
to replicate your problem, using one of the
[datasets shipped with MNE-Python](https://mne.tools/dev/overview/datasets_index.html),
preferably the one called [sample](https://mne.tools/dev/overview/datasets_index.html#sample).
If you can't replicate on a built-in dataset, provide also a link to a small,
anonymized portion of your data that does yield the error.
- type: textarea
attributes:
label: Expected results

- type: textarea
attributes:
label: Actual results
description: |
Please provide the actual output, traceback, screenshot, or another description of the results.
- type: textarea
attributes:
label: Additional information
description: |
Replace this text with information about your system. For example through
using MNE-Python and running `mne.sys_info()` and pasting the output here.
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: MNE-Python forum
url: https://mne.discourse.group/
about: 💬 Use the [MNE-Python forum](https://mne.discourse.group/) to ask (and answer) concrete technical questions or about usage of MNE-BIDS
- name: BIDS specification
url: https://bids-specification.readthedocs.io/en/latest/
about: 📖 Read the BIDS specification
23 changes: 0 additions & 23 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Feature request

# See the json schema to help you create / update this form
# https://json.schemastore.org/github-issue-forms.json

description: 🛠️ Suggest an idea for this project

labels: ["enhancement"]

body:

- type: markdown
attributes:
value: |
Please use the [MNE-Python forum](https://mne.discourse.group/) to ask (and answer)
concrete technical questions or about usage of MNE-BIDS.
Use this form if you want to suggest new features.
- type: textarea
attributes:
label: Describe the problem
description: |
Please provide a clear and concise description of the problem.
- type: textarea
attributes:
label: Describe your solution
description: |
A clear and concise description of what you want to happen.
- type: textarea
attributes:
label: Describe possible alternatives
description: |
A clear and concise description of any alternative solutions or features you have considered.
- type: textarea
attributes:
label: Additional context
description: |
Add any other context or screenshots about the feature request here.

0 comments on commit 43b77c9

Please sign in to comment.