diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..f167b5e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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()`.〉 diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md new file mode 100644 index 0000000..c84822b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/custom.md @@ -0,0 +1,10 @@ +--- +name: Custom issue template +about: Create an issue without a template +title: '' +labels: '' +assignees: '' + +--- + + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..ed343b8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -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.〉