aboutsummaryrefslogtreecommitdiff
path: root/.github/ISSUE_TEMPLATE/bug_report.yaml
blob: 47fd3fe8a51c64ebc31a1f28979a5762aa327d1d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
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. If you can reproduce the issue run `RUST_BACKTRACE=1 hx -vv` to generate a more detailed log file.
      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).
        **Make sure that you are using the [latest helix release](https://github.com/helix-editor/helix/releases) or a newer master build**
      placeholder: "helix 22.12 (5eaa6d97)"
    validations:
      required: true