diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 2ebcafc15..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: C-bug, S-needs-triage -assignees: '' - ---- - -## Description - - - -[short summary of the bug] - -### Steps to Reproduce - -I tried this: - -[behavior or code sample that causes the bug] - -```sh -copy and paste the exact commands or code here -``` - -### Expected Behaviour - -I expected to see this happen: [explanation] - -### Actual Behaviour - -Instead, this happened: [explanation] - -### Zebra Logs - - - -
- -``` -copy and paste the logs here -``` - -
- -## Environment - -### Zebra Version - - - -### Operating System - - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..f3bf463a1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,71 @@ +name: Bug report +description: Create a report to help us improve +title: '[User reported bug]: ' +labels: C-bug, S-needs-triage +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Also tell us, what did you expect to happen? + value: "I expected to see this happen: + + + Instead, this happened: + + " + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: What were you doing when the issue happened? + description: Copy and paste the exact commands or code here. + placeholder: "Behavior or code sample that causes the bug" + validations: + required: false + - type: textarea + id: logs + attributes: + label: Zebra logs + description: Copy and paste the last 100 Zebra log lines or upload the full logs to https://gist.github.com/ and add a link to them here. + placeholder: "Copy and paste the logs here" + validations: + required: false + - type: input + id: zebrad-version + attributes: + label: Zebra Version + description: "For bugs in `zebrad`, run `zebrad --version`." + placeholder: "zebrad 1.0.0-placeholder" + validations: + required: false + - type: checkboxes + id: os + attributes: + label: Which operating systems does the issue happen on? + description: You may select more than one. + options: + - label: Linux + - label: macOS + - label: Windows + - label: Other OS + - type: input + id: os-details + attributes: + label: OS details + description: "Linux, macOS, BSD: the output of `uname -a`; Windows: version and 32-bit or 64-bit; Other OS: name and version" + placeholder: + validations: + required: false + - type: textarea + id: anything-else + attributes: + label: Additional information + description: Is there anything else that could help us solve this issue? + validations: + required: false diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4788d60ab..7d8ce5326 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,8 +14,7 @@ how to build, run, and instrument Zebra. ## Bug Reports [bug-reports]: #bug-reports -[File an issue](https://github.com/ZcashFoundation/zebra/issues/new/choose) -on the issue tracker using the bug report template. +Please [create an issue](https://github.com/ZcashFoundation/zebra/issues/new?assignees=&labels=C-bug%2C+S-needs-triage&projects=&template=bug_report.yml&title=) on the Zebra issue tracker. ## Pull Requests [pull-requests]: #pull-requests