Skip to content

Commit 48e9040

Browse files
authored
Improve issue templates (#1178)
1 parent 998615a commit 48e9040

File tree

2 files changed

+23
-22
lines changed

2 files changed

+23
-22
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,34 +7,35 @@ assignees: ''
77

88
---
99

10-
**Describe the bug**
11-
A clear and concise description of what the bug is.
10+
### Describe the bug
11+
<!-- A clear and concise description of what the bug is. -->
1212

13-
**To Reproduce**
14-
Steps to reproduce the behavior (please add longer code examples below):
1513

14+
### To Reproduce
15+
<!-- Steps to reproduce the behavior. Please add longer code examples below. -->
1616

17-
**Expected behavior**
18-
A clear and concise description of what you expected to happen.
1917

18+
### Expected behavior
19+
<!-- A clear and concise description of what you expected to happen. -->
2020

21-
**Additional context**
2221

23-
OS-version:
22+
### Additional context
23+
24+
OS and version:
2425
Python version:
2526
python-can version:
26-
python-can interface/s:
27+
python-can interface/s (if applicable):
2728

2829
<!-- Add any other context about the problem here. -->
29-
30+
3031
<details><summary>Traceback and logs</summary>
31-
<!-- have to be followed by an empty line! -->
32-
32+
<!-- Has to be followed by an empty line! -->
33+
3334
<!-- More details such as a minimal script to demonstrate the bug, relevant logs and any tracebacks go here. -->
34-
35+
3536
<!-- Code examples can be included: -->
3637
```python
3738
def func():
38-
return 'hello, world!'
39+
return "hello, world!"
3940
```
4041
</details>

.github/ISSUE_TEMPLATE/feature_request.md

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

88
---
99

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 [...]
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 [...] -->
1212

13-
**Describe the solution you'd like**
14-
A clear and concise description of what you want to happen.
13+
### Describe the solution you'd like
14+
<!-- A clear and concise description of what you want to happen. -->
1515

16-
**Describe alternatives you've considered**
17-
A clear and concise description of any alternative solutions or features you've considered.
16+
### Describe alternatives you've considered
17+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
1818

19-
**Additional context**
20-
Add any other context or screenshots about the feature request here.
19+
### Additional context
20+
<!-- Add any other context or screenshots about the feature request here. -->

0 commit comments

Comments
 (0)