Skip to content

Commit

Permalink
Update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
tsbinns authored Sep 18, 2024
1 parent c47c454 commit d2ab4f9
Show file tree
Hide file tree
Showing 3 changed files with 78 additions and 0 deletions.
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
name: Bug report
about: Tell us about broken, incorrect, or inconsistent behavior
title: "[BUG]"
labels: bug
assignees: ''

---

#### Describe the bug
〈Replace this text with a clear and concise description of the bug.〉


#### Steps to reproduce
〈Replace this text with a code snippet or minimal working example [MWE] to
replicate your problem. This example should involve some simulated data (e.g.,
one of those shipped with PyBispectra `pybispectra.data.example_data.DATASETS`
that can be loaded with `pybispectra.get_example_data_paths()`), or one of the
[datasets shipped with MNE-Python] (e.g., the [sample] dataset). If you cannot
replicate the error on a built-in dataset, provide a link to a small,
anonymised portion of your data that yields the error.〉

[MWE]: https://en.wikipedia.org/wiki/Minimal_Working_Example
[datasets shipped with MNE-Python]: https://mne.tools/stable/documentation/datasets.html
[sample]: https://mne.tools/stable/documentation/datasets.html#sample


#### Expected results
〈Replace this text with a clear and concise description of what you expected to
happen.〉


#### Actual results
〈Replace this text with the actual output, traceback, screenshot, or other
description of the results.〉


#### Additional information
〈Replace this text with information about your system. This should include
information about the PyBispectra version (`pybispectra.__version__`) as well
as other information that can be found with MNE by running `import mne;
mne.sys_info()`.〉
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/custom.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: Custom issue template
about: Create an issue without a template
title: ''
labels: ''
assignees: ''

---


26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Feature request
about: Suggest an idea for this project
title: "[ENH]"
labels: enhancement
assignees: ''

---

#### Describe what is missing
〈Replace this text with a clear and concise description of the missing
feature.〉


#### Describe your solution
〈Replace this text with a clear and concise description of how the missing
feature could be implemented.〉

#### Describe possible alternatives
〈Replace this text with a clear and concise description of possible alternative
features or implementations that could help to address the problem.〉


#### Additional information
〈Replace this text with additional information that is relevant to the feature
and proposed implementations.〉

0 comments on commit d2ab4f9

Please sign in to comment.