git.iko.soy/helix
on master help sign in
Improve bug report template (#1826)
533cca7Ivan Tham
.github/ISSUE_TEMPLATE/bug_report.mddeleted−29
compare with master
unifiedsplit
@@ -1,29 +0,0 @@
1−---
2−name: Bug report
3−about: Create a report to help us improve
4−title: ''
5−labels: C-bug
6−assignees: ''
7−
8−---
9−
10−<!-- Your issue may already be reported!
11−Please search on the issue tracker before creating one. -->
12−
13−### Reproduction steps
14−
15−<!-- Ideally provide a key sequence and/or asciinema.org recording. -->
16−
17−### Environment
18−
19−- Platform: <!-- macOS / Windows / Linux -->
20−- Terminal emulator:
21−- Helix version: <!-- 'hx -V' if using a release, 'git describe' if building from master -->
22−
23−<details><summary>~/.cache/helix/helix.log</summary>
24−
25−```
26−please provide a copy of `~/.cache/helix/helix.log` here if possible, you may need to redact some of the lines
27−```
28−
29−</details>
.github/ISSUE_TEMPLATE/bug_report.yamlnew file+67
@@ -0,0 +1,67 @@
1+name: Bug Report
2+description: Create a report to help us improve
3+labels: C-bug
4+body:
5+ - type: markdown
6+ attributes:
7+ value: Thank you for filing a bug report! 🐛
8+ - type: textarea
9+ id: problem
10+ attributes:
11+ label: Summary
12+ description: >
13+ Please provide a short summary of the bug, along with any information
14+ you feel relevant to replicate the bug.
15+ validations:
16+ required: true
17+ - type: textarea
18+ id: reproduction-steps
19+ attributes:
20+ label: Reproduction Steps
21+ value: |
22+ <!-- Ideally provide a key sequence and/or asciinema.org recording. -->
23+
24+ I tried this:
25+
26+ 1. `hx`
27+
28+ I expected this to happen:
29+
30+ Instead, this happened:
31+ - type: textarea
32+ id: helix-log
33+ attributes:
34+ label: Helix log
35+ description: See `hx -h` for log file path
36+ value: |
37+ <details><summary>~/.cache/helix/helix.log</summary>
38+
39+ ```
40+ please provide a copy of `~/.cache/helix/helix.log` here if possible, you may need to redact some of the lines
41+ ```
42+
43+ </details>
44+ - type: input
45+ id: platform
46+ attributes:
47+ label: Platform
48+ placeholder: Linux / macOS / Windows
49+ validations:
50+ required: true
51+ - type: input
52+ id: terminal-emulator
53+ attributes:
54+ label: Terminal Emulator
55+ placeholder: wezterm 20220101-133340-7edc5b5a
56+ validations:
57+ required: true
58+ - type: input
59+ id: helix-version
60+ attributes:
61+ label: Helix Version
62+ description: >
63+ Helix version (`hx -V` if using a release, `git describe` if building
64+ from master)
65+ placeholder: "helix 0.6.0 (c0dbd6dc)"
66+ validations:
67+ required: true