summaryrefslogtreecommitdiff
path: root/.github/ISSUE_TEMPLATE/crash_report.yml
blob: 059d123edc6a4198c3e9a955d64f2422a5b03463 (plain)
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
name: Crash report
description: Report a crash of the editor while in-use
labels: bug, crash
title: "[BUG][CRASH] "
body:

    - type: markdown
      attributes:
        value: |
            Please make sure to [search issues](https://github.com/mawww/kakoune/issues?q=is%3Aissue) before creating a new one, to avoid duplicates and centralise conversations.

            If you need to have a question about the editor itself (options, behaviour, code…) answered, make sure to check the [documentation](https://github.com/mawww/kakoune/tree/master/doc/pages) (also available via the `doc` command in the editor) or drop by [IRC](https://web.libera.chat/?channels=#kakoune) to get instant feedback.

    - type: input
      attributes:
          label: "Version of Kakoune"
          description: "If unsure, use the output of command: `kak -version`"
          placeholder: "v2020.12.31"
      validations:
          required: true

    - type: textarea
      attributes:
          label: "Reproducer"
          description: "What are the steps to follow to reproduce the issue?"
          placeholder: |
              If any specific configuration or environment settings are required to reproduce the issue, also describe them here.
      validations:
        required: true

    - type: textarea
      attributes:
          label: "Outcome"
          description: "What is the outcome of the reproducing steps above?"
          placeholder: |
              If the editor printed any error messages, or if you managed to obtain a backtrace, also document them here. Make sure to demangle the stacktrace by passing it to the `c++filt` command.

              Note that triggering the issue in the editor compiled in debug mode will produce more helpful messages, please consider re-building with `make debug=yes` to help us out.
      validations:
        required: true

    - type: textarea
      attributes:
          label: "Expectations"
          description: "What was the expected outcome of the reproducing steps above?"
          placeholder: |
              If the reproducing steps are self-evident, the expectations are simply “the editor should not crash”. In that case, you may ignore this field.
      validations:
        required: false

    - type: textarea
      attributes:
          label: "Additional information"
          description: "Any other information that may be relevant to diagnosing the issue should be documented here"
          placeholder: |
              Examples of relevant information:

              * What OS and distribution are you using?
              * Are you running an experimental branch (i.e. not `master`)?
              * Is the issue reproducible in other terminals?
      validations:
        required: false