Skip to content

Commit

Permalink
feat(github): add issue templates for asking questions, reporting bug…
Browse files Browse the repository at this point in the history
…s, and requesting features to improve issue quality and organization
  • Loading branch information
rootiest committed Jun 8, 2023
1 parent 5300524 commit 7b293bc
Show file tree
Hide file tree
Showing 3 changed files with 88 additions and 0 deletions.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/ask-a-question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: Ask a question
about: Ask a question about this project or anything printing-related
title: "[QUESTION]"
labels: question
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 [...]

**Clearly outline your question**
A clear and concise outline of what you are trying to ask.

> We aren't mind-readers!
**Describe your hypothesis**
Make a guess at what you think the answer is.
We don't expect you to know if you are asking.
But give us an idea where your thinking is at!

**Steps you've taken already**
Please provide a summary of any steps you have attempted already.

- Links to other resources where you looked for solutions.
- What you've already tried yourself
- Where you looked/google searches you performed.

> Make an effort to try to solve the problem yourself first before opening a ticket.
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
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.

**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 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: "[FEATURE]"
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.

0 comments on commit 7b293bc

Please sign in to comment.