Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved issue templates #1434

Merged
Merged
Show file tree
Hide file tree
Changes from 17 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.

90 changes: 90 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
name: Bug Report
description: File a bug report.
title: "[Bug]: "
labels: ["bug"]

body:
- type: markdown
attributes:
value: |
# Thanks for taking the time to fill out this bug report!
### The following information will help us resolve your issue.
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: Steps to Reproduce
description: |
Please copy and paste the code you were trying to run that caused the error.
Feel free to include as little or as much as you think is relevant. This section will be automatically formatted into code, so no need for backticks.
render: python
validations:
required: true
- type: textarea
id: traceback
attributes:
label: Traceback
description: |
Please copy and paste the traceback produced by the error.
This section will be automatically formatted into code, so no need for backticks.
render: python
- type: dropdown
id: os
attributes:
label: Operating System
options:
- Windows
- macOS
- Linux
validations:
required: true
- type: dropdown
id: executable
attributes:
label: Python Executable
options:
- Conda
- Python
validations:
required: true
- type: dropdown
id: python_version
attributes:
label: Python Version
options:
- 3.7
- 3.8
- 3.9
validations:
required: true
- type: textarea
id: package_versions
attributes:
label: Package Versions
description: |
Please share your currently installed Python package versions by calling `pip freeze > environment_for_issue.txt` and uploading the text file along with this issue.
This helps us determine if there are any secondary or tertiary issues caused by other dependencies.
You can attach images or log files by clicking this area to highlight it and then dragging files in.
If GitHub upload is not working, you can also copy and paste the output into this section.
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/NeurodataWithoutBorders/pynwb/blob/dev/.github/CODE_OF_CONDUCT.rst)
options:
- label: I agree to follow this project's [Code of Conduct](https://github.com/NeurodataWithoutBorders/pynwb/blob/dev/.github/CODE_OF_CONDUCT.rst)
required: true
- label: Have you checked the [Contributing](https://github.com/NeurodataWithoutBorders/pynwb/blob/dev/docs/CONTRIBUTING.rst) document?
required: true
- label: Have you ensured this bug was not already [reported](https://github.com/NeurodataWithoutBorders/pynwb/issues)?
required: true
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
blank_issues_enabled: true
contact_links:
- name: Learn more about NWB
url: https://www.nwb.org/
about: Initial entrypoint to NWB ecosystem.
- name: NWB Schema Documentation
url: https://nwb-schema.readthedocs.io/en/latest/
about: Current schema definitions.
- name: NWB Community and Contact
url: https://www.nwb.org/contact-us/
about: Have a bunch of really specific questions? Connect with the greater NWB community!
- name: NWB Best Practices
url: https://www.nwb.org/best-practices/
about: Check out the full list of Best Practices for making NWBFiles.
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: Documentation
description: Is the documentation of something missing, unclear, or lacking? This is the place.
title: "[Documentation]: "
labels: "documentation"
body:
- type: markdown
attributes:
value: |
## Thank you for your suggestion!
We welcome any ideas about how to make the **PyNWB** better for the community.
Please keep in mind that new or improved documentation may not get implemented immediately.
- type: textarea
id: summary
attributes:
label: What would you like changed or added to the documentation and why?
description: Do you have any suggestions for the documents?
validations:
required: true
- type: dropdown
id: interest
attributes:
label: Do you have any interest in helping write or edit the documentation?
description: |
We appreciate any help you can offer!
For information on how to contribute, please refer to our [contributing guidelines](https://github.com/NeurodataWithoutBorders/pynwb/blob/dev/docs/CONTRIBUTING.rst).
options:
- Yes.
- Yes, but I would need guidance.
- No.
validations:
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/NeurodataWithoutBorders/pynwb/blob/dev/.github/CODE_OF_CONDUCT.rst)
options:
- label: I agree to follow this project's [Code of Conduct](https://github.com/NeurodataWithoutBorders/pynwb/blob/dev/.github/CODE_OF_CONDUCT.rst)
required: true
- label: Have you checked the [Contributing](https://github.com/NeurodataWithoutBorders/pynwb/blob/dev/docs/CONTRIBUTING.rst) document?
required: true
- label: Have you ensured this change was not already [requested](https://github.com/NeurodataWithoutBorders/pynwb/issues)?
required: true
30 changes: 0 additions & 30 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

64 changes: 64 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
name: Feature Request
description: Suggest an idea for a brand new feature, or a change to an existing one.
title: "[Feature]: "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
## Thank you for your suggestion!
We welcome any ideas about how to make **PyNWB** better for the community.
Please keep in mind that new features may not get implemented immediately.
- type: textarea
id: summary
attributes:
label: What would you like to see added to PyNWB?
description: |
What are you trying to achieve with **PyNWB**?
Is this a more convenient way to do something that is already possible, or is a workaround currently unfeasible?
validations:
required: true
- type: textarea
id: problem
attributes:
label: Is your feature request related to a problem?
description: A clear and concise description of what the problem is.
- type: textarea
id: solution
attributes:
label: What solution would you like?
description: |
A clear and concise description of what you want to happen.
Describe alternative solutions you have considered.
validations:
required: true
- type: dropdown
id: interest
attributes:
label: Do you have any interest in helping implement the feature?
description: |
We appreciate any help you can offer!
For information on how to contribute, please refer to our [contributing guidelines](https://github.com/NeurodataWithoutBorders/pynwb/blob/dev/docs/CONTRIBUTING.rst).
options:
- Yes.
- Yes, but I would need guidance.
- No.
validations:
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/NeurodataWithoutBorders/pynwb/blob/dev/.github/CODE_OF_CONDUCT.rst)
options:
- label: I agree to follow this project's [Code of Conduct](https://github.com/NeurodataWithoutBorders/pynwb/blob/dev/.github/CODE_OF_CONDUCT.rst)
required: true
- label: Have you checked the [Contributing](https://github.com/NeurodataWithoutBorders/pynwb/blob/dev/docs/CONTRIBUTING.rst) document?
required: true
- label: Have you ensured this change was not already [requested](https://github.com/NeurodataWithoutBorders/pynwb/issues)?
required: true
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
### Minor improvements:
- Improve constructor docstrings for Image types. @weiglszonja (#1418)
- Add checks for data orientation in ``TimeSeries``, ``ElectricalSeries``, and ``RoiResponseSeries`` @bendichter (#1428)
- Enhanced issue template forms on GitHub. @CodyCBakerPHD (#1434)


### Documentation enhancements:
Expand Down