Skip to content

Commit 2f23f75

Browse files
authored
Update issue templates
1 parent 1fb6074 commit 2f23f75

File tree

2 files changed

+48
-21
lines changed

2 files changed

+48
-21
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 29 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,41 @@ assignees: ''
77

88
---
99

10-
**Describe the bug**
10+
<!--
11+
Please abide by our [Code of Conduct, which can be found here](https://github.com/jonescompneurolab/hnn-core/blob/master/CODE_OF_CONDUCT.md). Failure to do so will result in the consequences explained in that document.
12+
-->
13+
14+
**Describe the bug:**
15+
<!--
1116
A clear and concise description of what the bug is.
17+
-->
1218

13-
**To Reproduce**
14-
Steps to reproduce the behavior. If bug is in GUI, please describe the steps. If the bug is an error with the API, then **please include a script that reproduces the bug** when possible.
19+
**Steps To Reproduce:**
20+
<!--
21+
Steps to reproduce the behavior. If the bug is in the GUI, please describe the steps. If the bug is an error with the API (Python code), then **make sure to include a script that reproduces the bug** .
22+
-->
1523

16-
**Expected behavior**
24+
**Expected behavior:**
25+
<!--
1726
A clear and concise description of what you expected to happen.
27+
-->
1828

19-
**Screenshots**
20-
If applicable, add screenshots to help explain your problem.
29+
**Actual behavior:**
30+
<!--
31+
A clear and concise description of what happened instead of what you expected.
32+
-->
2133

2234
**Installation (please complete the following information):**
23-
- OS: [e.g. macOS]
24-
- Python Version [e.g. 3.14]
25-
- HNN-Core version [e.g. v0.5.0]
35+
- OS:
36+
<!-- [e.g. macOS] -->
2637

27-
**Additional context**
28-
Add any other context about the problem here.
38+
- Python Version:
39+
<!-- [e.g. 3.12] -->
2940

30-
**Code of Conduct**
31-
Please abide by our [Code of Conduct, which can be found here](https://github.com/jonescompneurolab/hnn-core/blob/master/CODE_OF_CONDUCT.md). Failure to do so will result in the consequences explained in that document.
41+
- HNN-Core version:
42+
<!-- [e.g. v0.5.0] -->
43+
44+
**Additional context**
45+
<!--
46+
Add any other context about the problem here. You can include screenshots here or elsewhere if that is relevant to your issue.
47+
-->

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,31 @@ assignees: ''
77

88
---
99

10+
<!--
11+
Please abide by our [Code of Conduct, which can be found here](https://github.com/jonescompneurolab/hnn-core/blob/master/CODE_OF_CONDUCT.md). Failure to do so will result in the consequences explained in that document.
12+
-->
13+
1014
**Is your feature request related to a problem? Please describe.**
11-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
15+
<!--
16+
A clear and concise description of what the problem is. Example: "It would be useful if HNN-Core could plot the following..."
17+
-->
1218

13-
**Have you checked that desired feature is not already in development?**
19+
**Have you checked that desired feature is NOT already in development by someone else?**
20+
<!--
1421
Please [review our standing Issues here](https://github.com/jonescompneurolab/hnn-core/issues) to ensure that this is not a duplicate of a pre-existing feature request.
22+
-->
1523

16-
**Describe the solution you'd like**
24+
**Describe the solution you'd like:**
25+
<!--
1726
A clear and concise description of what you want to happen.
27+
-->
1828

19-
**Describe alternatives you've considered**
29+
**Describe alternatives you've considered:**
30+
<!--
2031
A clear and concise description of any alternative solutions or features you've considered.
32+
-->
2133

22-
**Additional context**
34+
**Additional context:**
35+
<!--
2336
Add any other context or screenshots about the feature request here.
24-
25-
**Code of Conduct**
26-
Please abide by our [Code of Conduct, which can be found here](https://github.com/jonescompneurolab/hnn-core/blob/master/CODE_OF_CONDUCT.md). Failure to do so will result in the consequences explained in that document.
37+
-->

0 commit comments

Comments
 (0)