Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 0 additions & 34 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

65 changes: 65 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: Bug report
description: Report a reproducible problem in mne-denoise.
title: ""
labels:
- bug
body:
- type: markdown
attributes:
value: |
Usage and support questions belong on the [MNE Forum](https://mne.discourse.group/).
Use this form for suspected bugs in mne-denoise.

- type: textarea
id: description
attributes:
label: Description
description: Describe the incorrect behavior and when it occurs.
placeholder: Tell us what went wrong.
validations:
required: true

- type: textarea
id: reproducible-example
attributes:
label: Minimal reproducible example
description: Provide the smallest runnable example that reproduces the problem. Use the public API.
render: python
validations:
required: true

- type: textarea
id: data-context
attributes:
label: Data and context (optional)
description: Include data characteristics or a small sample only when they are needed to reproduce the problem.

- type: textarea
id: expected-result
attributes:
label: Expected result
description: What did you expect to happen?
validations:
required: true

- type: textarea
id: actual-result
attributes:
label: Actual result
description: What happened? Include the complete traceback or relevant output when available.
render: text
validations:
required: true

- type: textarea
id: environment
attributes:
label: Environment
description: Include the versions and operating system used for the reproducer.
placeholder: |
Python:
mne-denoise:
MNE-Python (if relevant):
Operating system:
validations:
required: true
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: MNE Forum
url: https://mne.discourse.group/
about: Ask usage and support questions in the MNE community forum.
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Documentation issue
description: Report unclear, missing, incorrect, or stale documentation.
title: ""
body:
- type: input
id: location
attributes:
label: Documentation location
description: Give the page, docstring, example, or API entry where the problem appears.
placeholder: Paste a URL or file and section name.
validations:
required: true

- type: textarea
id: problem
attributes:
label: Problem
description: What is incorrect, unclear, missing, or stale?
placeholder: Describe the documentation problem.
validations:
required: true

- type: textarea
id: suggested-improvement
attributes:
label: Suggested improvement (optional)
description: If you have an idea for a correction, share it here.
19 changes: 0 additions & 19 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Feature request
description: Suggest a capability or scientific enhancement for mne-denoise.
title: ""
labels:
- enhancement
body:
- type: textarea
id: problem
attributes:
label: Problem or scientific use case
description: What are you trying to accomplish, and what is currently missing?
placeholder: Describe the user or scientific need.
validations:
required: true

- type: textarea
id: desired-behavior
attributes:
label: Desired behavior
description: What capability or change would help?
placeholder: Describe the outcome you would like.
validations:
required: true

- type: input
id: scientific-reference
attributes:
label: Scientific reference (optional)
description: Add a paper, DOI, or other reference when the request concerns a published method.

- type: textarea
id: alternatives
attributes:
label: Alternatives and additional context (optional)
description: Share workarounds, alternatives, examples, or other context. Implementation details are not required.
40 changes: 12 additions & 28 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,16 @@
# Pull Request
<!--
Please read CONTRIBUTING.md before opening a pull request.

## Description
Keep this pull request focused and link the relevant issue when one exists.
Explain the motivation and the behavior implemented or fixed. For scientific
changes, identify the primary reference and explain intentional deviations or
extensions. Add or update tests, documentation, and a changelog fragment when
applicable. Disclose AI assistance according to CONTRIBUTING.md, including the
tool, manner, and scope of assistance.
-->

<!-- Provide a general summary of your changes in the Title above -->
<!-- Please describe your changes in detail -->
#### Reference issue (if any)

## Related Issue
#### What does this implement/fix?

<!-- This project only accepts pull requests related to open issues -->
<!-- If suggesting a new feature or change, please discuss it in an issue first -->
<!-- If fixing a bug, there should be an issue describing it with steps to reproduce -->
<!-- Please link to the issue here: -->

## Type of Change

<!-- Please delete options that are not relevant -->

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Documentation update

## Checklist

<!-- Please check each item below -->

- [ ] My code follows the code style of this project (`spin lint`)
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] I have run the full test suite and all tests pass
- [ ] I have updated the documentation accordingly (`spin docs` builds without warnings)
- [ ] I have added a numbered Towncrier fragment in `docs/changes/devel/` (if applicable)
#### Additional information
Loading