Skip to content

Commit

Permalink
Init issue templates for bug reports and feature requests
Browse files Browse the repository at this point in the history
  • Loading branch information
nkaskov committed Dec 6, 2023
1 parent 64a0635 commit c1bc3aa
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 0 deletions.
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: Bug report
about: Create a report to help us improve
title: "[Possible bug] name_your_feature_request"
labels: bug
assignees: nkaskov

---

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

**To Reproduce**
How to reproduce the behavior:
1. Code snippet (if it is small)
2. Link to a public repository (if the code is too big)

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

**Toolchain versions**
1. If you have built `zkllvm` from source - give us the commit you are on in `zkllvm` repository and in its submodules `assigner` and `circifier`. They are being updated quite often and might be outdated on the local setup.
2. If you are using a binary version - please provide the result of the following command:
`assigner --version`


**Backtrace**
If you have the backtrace - please attach it as text or file. It will help us a lot with the debug.
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: "[Feature request]: name_your_feature_request"
labels: enhancement
assignees: nkaskov

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is.

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

**Additional context**
It would help us to find the proper solution if you could describe a bit more about what algorithm you are trying to compile. It could be, for example, a public repository with your ongoing work, or a link to a discussion/proposal on ETH research.

0 comments on commit c1bc3aa

Please sign in to comment.