Skip to content

Commit

Permalink
Update issue templates (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
TooDissing committed Feb 19, 2022
1 parent 8ea931d commit e0e8dd6
Show file tree
Hide file tree
Showing 4 changed files with 93 additions and 0 deletions.
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
name: Bug report
about: Create a report to help us improve
title: "[BUG]"
labels: bug
assignees: ''

---

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

**Which parts of the speaker are affected**
Describe which part of the speaker that is at fault; i.e. the cabinet, the PCB design or the software platform

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

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

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
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.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/implementation-task.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: Implementation task
about: Tasks with a clear and defined scope that is ready to implement (not a feature
request)
title: ''
labels: enhancement
assignees: ''

---

### Description

**Add a detailed description of the scope of this task**

### Definition of Done
1. list
2. all
3. items

#### Documentation
Which part of the documentation needs to be updated or extended?
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
name: Question
about: Ask a question
title: ''
labels: question
assignees: ''

---

### Questions
Ask a questions for which you can't find the answer to in the documentation: [https://stroem.readthedocs.io](https://stroem.readthedocs.io)

0 comments on commit e0e8dd6

Please sign in to comment.