From 533cca7195b5ab36e0a1fa4863d00f6c11cb41b9 Mon Sep 17 00:00:00 2001 From: Ivan Tham Date: Fri, 18 Mar 2022 13:06:56 +0800 Subject: [PATCH] Improve bug report template (#1826) --- .github/ISSUE_TEMPLATE/bug_report.md | 29 ----------- .github/ISSUE_TEMPLATE/bug_report.yaml | 67 ++++++++++++++++++++++++++ 2 files changed, 67 insertions(+), 29 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 41b00230f..000000000 --- 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: '' - ---- - - - -### Reproduction steps - - - -### Environment - -- Platform: -- Terminal emulator: -- Helix version: - -
~/.cache/helix/helix.log - -``` -please provide a copy of `~/.cache/helix/helix.log` here if possible, you may need to redact some of the lines -``` - -
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 000000000..c67deb690 --- /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: | + + + 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: | +
~/.cache/helix/helix.log + + ``` + please provide a copy of `~/.cache/helix/helix.log` here if possible, you may need to redact some of the lines + ``` + +
+ - 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