aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIvan Tham2022-03-18 05:06:56 +0000
committerGitHub2022-03-18 05:06:56 +0000
commit533cca7195b5ab36e0a1fa4863d00f6c11cb41b9 (patch)
tree2badda39236465dd520a06192d0bf28f3fdd239e
parentcb7b674f870bcc0928b448d20fd04b6bf2fe8185 (diff)
Improve bug report template (#1826)
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md29
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.yaml67
2 files changed, 67 insertions, 29 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
deleted file mode 100644
index 41b00230..00000000
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
@@ -1,29 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: C-bug
-assignees: ''
-
----
-
-<!-- Your issue may already be reported!
-Please search on the issue tracker before creating one. -->
-
-### Reproduction steps
-
-<!-- Ideally provide a key sequence and/or asciinema.org recording. -->
-
-### Environment
-
-- Platform: <!-- macOS / Windows / Linux -->
-- Terminal emulator:
-- Helix version: <!-- 'hx -V' if using a release, 'git describe' if building from master -->
-
-<details><summary>~/.cache/helix/helix.log</summary>
-
-```
-please provide a copy of `~/.cache/helix/helix.log` here if possible, you may need to redact some of the lines
-```
-
-</details>
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml
new file mode 100644
index 00000000..c67deb69
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yaml
@@ -0,0 +1,67 @@
+name: Bug Report
+description: Create a report to help us improve
+labels: C-bug
+body:
+ - type: markdown
+ attributes:
+ value: Thank you for filing a bug report! 🐛
+ - type: textarea
+ id: problem
+ attributes:
+ label: Summary
+ description: >
+ Please provide a short summary of the bug, along with any information
+ you feel relevant to replicate the bug.
+ validations:
+ required: true
+ - type: textarea
+ id: reproduction-steps
+ attributes:
+ label: Reproduction Steps
+ value: |
+ <!-- Ideally provide a key sequence and/or asciinema.org recording. -->
+
+ I tried this:
+
+ 1. `hx`
+
+ I expected this to happen:
+
+ Instead, this happened:
+ - type: textarea
+ id: helix-log
+ attributes:
+ label: Helix log
+ description: See `hx -h` for log file path
+ value: |
+ <details><summary>~/.cache/helix/helix.log</summary>
+
+ ```
+ please provide a copy of `~/.cache/helix/helix.log` here if possible, you may need to redact some of the lines
+ ```
+
+ </details>
+ - type: input
+ id: platform
+ attributes:
+ label: Platform
+ placeholder: Linux / macOS / Windows
+ validations:
+ required: true
+ - type: input
+ id: terminal-emulator
+ attributes:
+ label: Terminal Emulator
+ placeholder: wezterm 20220101-133340-7edc5b5a
+ validations:
+ required: true
+ - type: input
+ id: helix-version
+ attributes:
+ label: Helix Version
+ description: >
+ Helix version (`hx -V` if using a release, `git describe` if building
+ from master)
+ placeholder: "helix 0.6.0 (c0dbd6dc)"
+ validations:
+ required: true