Skip to content

Commit 36250ae

Browse files
authored
chore: create issue templates
Create 3 issue templates to make it easier to triage incoming issues into bug reports, feature requests, or questions.
1 parent d3e44d6 commit 36250ae

File tree

3 files changed

+57
-0
lines changed

3 files changed

+57
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve.
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+
Your bug has a higher chance of being fixed if it can be reproduced by others. Therefore, it's very good to try to create a minimum setup that displays the erroneous behaviour (e.g. test RTP stream, create a failing unit test, etc...)
15+
16+
Steps to reproduce the behavior:
17+
1. Set up '...'
18+
2. Do this '...'
19+
3. See error
20+
21+
**Screenshots**
22+
If applicable, add screenshots to help explain your problem.
23+
24+
**Environment (please complete the following information):**
25+
- OS: [e.g. Windows, Linux, iOS]
26+
- Browser [e.g. Chrome, Firefox, Safari] or Node.js + version
27+
- Version [e.g. 6.0.1]
28+
29+
**Additional context**
30+
Add any other context about the problem here.
+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project.
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+
**Additional context**
17+
Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/question.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
name: Question
3+
about: Ask a technical question related to this project.
4+
title: ''
5+
labels: question
6+
assignees: ''
7+
8+
---
9+
10+
Tell us what's on your mind.

0 commit comments

Comments
 (0)