Skip to content

Commit

Permalink
Infra: Update issue template (#893)
Browse files Browse the repository at this point in the history
* Update issue templates

Infra: Slightly modified the GH default templates for Issue and Bug.

* Update bug_report.md

* Made the reproduction step example more brevitas-ish

* Update bug_report.md

Changed Screenshots to include code/log info

* Fix pre-commit

* feat: added missing feature request template

* Updated repro section in bug_report.md

* Update bug_report.md to include pytorch/os version info.

---------

Co-authored-by: Anton Gerdelan <capnramses@users.noreply.github.com>
  • Loading branch information
nickfraser and capnramses authored Mar 14, 2024
1 parent 0bcf34d commit b35f0ec
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 0 deletions.
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
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.

**Reproducibility**
- [ ] Can be reproduced consistently.
- [ ] Difficult to reproduce.
- [ ] Unable to reproduce.

**To Reproduce**

Steps to reproduce the behavior. For example:

1. When using Brevitas layer-wise/PTQ/export feature '...'
2. With model '....'
3. And then running '....'
4. See error

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

**Screenshots/Code Example/Log Output**
If applicable, add screenshots, code blocks, or output text to help explain your problem.

**please complete the following information:**

_If known:_

- Brevitas version:
- PyTorch version:
- Operating System / platform:

**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.

0 comments on commit b35f0ec

Please sign in to comment.