Skip to content

Commit

Permalink
chore: create issue templates
Browse files Browse the repository at this point in the history
Create 3 issue templates to make it easier to triage incoming issues into bug reports, feature requests, or questions.
  • Loading branch information
steabert authored Jul 23, 2019
1 parent d3e44d6 commit 36250ae
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 0 deletions.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: Bug report
about: Create a report to help us improve.
title: ''
labels: bug
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
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...)

Steps to reproduce the behavior:
1. Set up '...'
2. Do this '...'
3. See error

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Environment (please complete the following information):**
- OS: [e.g. Windows, Linux, iOS]
- Browser [e.g. Chrome, Firefox, Safari] or Node.js + version
- Version [e.g. 6.0.1]

**Additional context**
Add any other context about the problem here.
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: Feature request
about: Suggest an idea for this project.
title: ''
labels: enhancement
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Additional context**
Add any other context or screenshots about the feature request here.
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: Question
about: Ask a technical question related to this project.
title: ''
labels: question
assignees: ''

---

Tell us what's on your mind.

0 comments on commit 36250ae

Please sign in to comment.