Skip to content

Commit

Permalink
MRG, MAINT: update issue templates (mne-tools#8365)
Browse files Browse the repository at this point in the history
* update issue templates

* rename

* remove blank

* cruft

* RFC: Create SECURITY.md (mne-tools#8358)

* Create SECURITY.md

WIP.  Needs discussion about preferred reporting method for security vulnerabilities, if any are ever discovered.

Also this file would need to get updated every time a release is made, so the release process wiki should be edited to mention that.

* add email address

* Let Eric finish my sentences :)

Co-authored-by: Eric Larson <[email protected]>

* expand based on example in MPL repo

Co-authored-by: Eric Larson <[email protected]>

[ci skip]

* add SECURITY.md to manifest

* add "questions" template; tweak others
  • Loading branch information
drammock authored Oct 13, 2020
1 parent 7781b9e commit 6dff3f2
Show file tree
Hide file tree
Showing 8 changed files with 83 additions and 45 deletions.
5 changes: 0 additions & 5 deletions .github/ISSUE_TEMPLATE/blank.md

This file was deleted.

40 changes: 24 additions & 16 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,54 @@
---
name: Bug report
about: Tell us about broken, incorrect, or inconsistent behavior.

title: ''
labels: BUG
assignees: ''
---

**READ THIS FIRST:** If you are having trouble getting MNE-Python to work with
your own data, you should probably ask for help on our
[Gitter channel](https://gitter.im/mne-tools/mne-python) or on our
[mailing list](https://mail.nmr.mgh.harvard.edu/mailman/listinfo/mne_analysis)
before opening an issue; you will get help faster that way. See
your own data, you should ask for help on one of our other channels:

- [email list](https://mail.nmr.mgh.harvard.edu/mailman/listinfo/mne_analysis)
- [Gitter (chat)](https://gitter.im/mne-tools/mne-python)

Our GitHub issue tracker is only used to report bugs and suggest improvements
to MNE-Python. For any other questions, please use the email list or Gitter.
Usage questions that are posted as GitHub issues are usually closed without
being answered. See
[the FAQ entry on filing bug reports](https://mne.tools/dev/overview/faq.html#i-think-i-found-a-bug-what-do-i-do)
for more guidance. If you're pretty sure your problem is a bug in MNE-Python,
**delete this section** and fill in the headings below, replacing the
please **delete this section** and fill in the headings below, replacing the
placeholder text with your own responses. Surround any code samples with triple
backticks above and below the code block, or put code in a
[public gist](https://gist.github.com) and link to it in the issue.
backticks above and below the code block (see
[the GitHub guide to markdown](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown)
for help with issue formatting). Alternatively, you can put your MWE in a
[public gist](https://gist.github.com) and link to it in this issue.


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


#### Steps to reproduce
Replace this text with a code snippet or minimal working example [MWE] to
*Replace this text with a code snippet or minimal working example [MWE] to
replicate your problem, using one of the [built-in datasets], preferably the
one called [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.
a link to a small, anonymized portion of your data that does yield the error.*

[MWE]: https://en.wikipedia.org/wiki/Minimal_Working_Example
[built-in datasets]: https://mne.tools/dev/overview/datasets_index.html
[sample]: https://mne.tools/dev/overview/datasets_index.html#sample


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


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


#### Additional information
Replace this text with the output of `mne.sys_info()`.
*Replace this text with the output of `mne.sys_info()`.*
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: Mailing list
url: http://mail.nmr.mgh.harvard.edu/mailman/listinfo/mne_analysis
about: For questions about analysis and usage, and announcements of interest to the neuroimaging community
- name: Gitter
url: https://gitter.im/mne-tools/mne-python
about: Users and developers can chat, troubleshoot and share code samples on our gitter channel
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: Documentation
about: Request a new tutorial, an improvement to an existing tutorial, or a new term in our glossary.
title: ''
labels: DOC
assignees: ''
---

*Please make the issue title a succinct description of your proposed change.
For example: "add 'foo' to the glossary" or "add my favorite visualization to
the ERP tutorial".*

#### Proposed documentation ehancement
*Describe your proposed enhancement in detail. If you are requesting a new
glossary term, please include a proposed definition.*
27 changes: 16 additions & 11 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,27 @@
---
name: Feature request
about: Suggest an idea for this project.

about: Suggest additions or improvements to MNE-Python.
title: ''
labels: ENH
assignees: ''
---

If your issue is a usage question, please consider asking on our [Gitter channel](https://gitter.im/mne-tools/mne-python) or on our [mailing list](https://mail.nmr.mgh.harvard.edu/mailman/listinfo/mne_analysis) instead of opening an issue.

#### Describe the problem
Please provide a clear and concise description of the problem.
#### Describe the new feature or enhancement
*Please provide a clear and concise description of what you want to add or
change.*


#### Describe your solution
A clear and concise description of what you want to happen.
#### Describe your proposed implementation
*Describe how you think the feature or improvement should be implemented (e.g.,
as a new method on an existing class? as new capability added to an existing
method?) If you're not sure, please delete this section and the next section.*


#### Describe possible alternatives
A clear and concise description of any alternative solutions or features you have considered.
*If you've suggested an implementation above, list here any alternative
implementations you can think of, and brief comments explaining why the chosen
implementation is better.*


#### Additional context
Add any other context or screenshots about the feature request here.
#### Additional comments
*Add any other context or screenshots about the feature request here.*
13 changes: 0 additions & 13 deletions .github/ISSUE_TEMPLATE/glossary.md

This file was deleted.

19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: Question/Support/Other
about: If you have a usage question...
title: ''
labels: USAGE
assignees: ''
# This template is based on the matplotlib template
# https://github.com/matplotlib/matplotlib/blob/d9aee8eb2bd989d6cfbe21c31ff086dab935bde5/.github/ISSUE_TEMPLATE/questions.md
---

If your issue is a usage question, you should ask for help on one of our other channels:

- [email list](https://mail.nmr.mgh.harvard.edu/mailman/listinfo/mne_analysis)
- [Gitter (chat)](https://gitter.im/mne-tools/mne-python)

Our GitHub issue tracker is only used to report bugs and suggest improvements
to MNE-Python. For any other questions, please use the email list or Gitter.
Usage questions that are posted as GitHub issues are usually closed without
being answered.
1 change: 1 addition & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
include *.rst
include LICENSE.txt
include SECURITY.md
include requirements.txt
include requirements_testing.txt
include requirements_doc.txt
Expand Down

0 comments on commit 6dff3f2

Please sign in to comment.