Skip to content

Commit 2050ed2

Browse files
authored
Create issue templates
1 parent 0e89241 commit 2050ed2

File tree

3 files changed

+65
-0
lines changed

3 files changed

+65
-0
lines changed
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us fix problems
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behaviour, preferably providing a simple code example (if the error happens in the middle of some complex code, please try to find a simpler, minimal example that demonstrates the error), and showing the full traceback.
15+
16+
If the error occurs when reading a file that you can't share publicly, please let us know, and we'll get in touch to discuss sharing it privately.
17+
18+
**Expected behaviour**
19+
If the bug is incorrect behaviour, rather than an unexpected Exception, please give a clear and concise description of what you expected to happen.
20+
21+
**Environment:**
22+
- OS: [e.g. macOS, Linux, Windows]
23+
- Python version
24+
- Neo version
25+
- NumPy version
26+
27+
**Additional context**
28+
Add any other context about the problem here.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Confusing documentation
3+
about: Let us know if the documentation is confusing or incorrect
4+
title: ''
5+
labels: Documentation
6+
assignees: ''
7+
8+
---
9+
10+
**Which page is the problem on?**
11+
The URL of the documentation page where the problem is, and either copy-paste the confusing text (for a short section of text), or give the first few and last few words (for a long section).
12+
13+
**What is the problem?**
14+
Is the documentation (a) confusing or (b) incorrect? In what way?
15+
16+
**Suggestions for fixing the problem**
17+
If the documentation is confusing, can you suggest an improvement? If the documentation is incorrect, what should it say instead?
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea to improve Neo
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**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 [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

0 commit comments

Comments
 (0)