Improve bug report template (#1826)
This commit is contained in:
parent
cb7b674f87
commit
533cca7195
2 changed files with 67 additions and 29 deletions
29
.github/ISSUE_TEMPLATE/bug_report.md
vendored
29
.github/ISSUE_TEMPLATE/bug_report.md
vendored
|
@ -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>
|
|
67
.github/ISSUE_TEMPLATE/bug_report.yaml
vendored
Normal file
67
.github/ISSUE_TEMPLATE/bug_report.yaml
vendored
Normal file
|
@ -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
|
Loading…
Add table
Reference in a new issue