Skip to content

Commit

Permalink
Update issue templates (#5)
Browse files Browse the repository at this point in the history
* Updated issue templates

Structured input for users submitting bugs, features, doc changes w/ GH Issues queue
  • Loading branch information
jeanniefinks committed Jan 22, 2021
1 parent 63d35cd commit 5432d66
Show file tree
Hide file tree
Showing 3 changed files with 67 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: Bug report
about: Create a report to help us improve
labels: bug

---

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

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

**Environment**
Include all relevant environment information:
1. OS [e.g. Ubuntu 18.04]:
2. Python version [e.g. 3.7]:
3. Sparsify version or commit hash [e.g. 0.1.0, `f7245c8`]:
4. ML framework version(s) [e.g. torch 1.7.1]:
5. Other Python package versions [e.g. SparseZoo, DeepSparse, numpy, ONNX]:
6. Other relevant environment information [e.g. hardware, CUDA version]:

**To Reproduce**
Exact steps to reproduce the behavior:


**Errors**
If applicable, add a full print-out of any errors or exceptions that are raised or include screenshots to help explain your problem.

**Additional context**
Add any other context about the problem here. Also include any relevant files.
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/doc-edit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: Doc edit
about: Propose changes to project documentation
labels: documentation

---

**What is the URL, file, or UI containing proposed doc change**
Where does one find the original content or where would this change go?

**What is the current content or situation in question**
Copy/paste the source content or describe gap.

**What is the proposed change**
Add new content.

**Additional context**
Add any other context about the change here. Also include any relevant files or URLs.
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: Feature request
about: Suggest an idea for this project
labels: enhancement

---

**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 5432d66

Please sign in to comment.