summaryrefslogtreecommitdiffstats
path: root/.github/ISSUE_TEMPLATE/BUG-REPORT.yml
blob: 7944195851739e257f8d74ca2d45c48e5775f4e2 (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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
name: I have a problem with the library
description: File a bug report.
labels: ["bug"]
body:
  - type: markdown
    attributes:
      value: |
        Thanks for taking the time to fill out this bug report!
  - type: checkboxes
    attributes:
      label: Is your issue REALLY a bug?
      description: |
        This issue tracker is for __BUG REPORTS ONLY__.

        It's obvious, right? This is a bug report form, after all! Still, some crazy users seem to forcefully fill out this form just to ask questions and request features.

        The core team does not appreciate that. Don't do it.

        If you want to ask a question or request a feature, please [go back here](https://github.com/iced-rs/iced/issues/new/choose) and read carefully.
      options:
      - label: My issue is indeed a bug!
        required: true
      - label: I am not crazy! I will not fill out this form just to ask a question or request a feature. Pinky promise.
        required: true
  - type: checkboxes
    attributes:
      label: Is there an existing issue for this?
      description: |
        Please, search [the existing issues] and see if an issue already exists for the bug you encountered.

        [the existing issues]: https://github.com/iced-rs/iced/issues
      options:
      - label: I have searched the existing issues.
        required: true
  - type: checkboxes
    attributes:
      label: Is this issue related to iced?
      description: |
        If your application is crashing during startup or you are observing graphical glitches, there is a chance it may be caused by incompatible hardware or outdated graphics drivers.

        Before filing an issue...

        - If you are using `wgpu`, you need an environment that supports Vulkan, Metal, or DirectX 12. Please, make sure you can run [the `wgpu` examples].

        If you have any issues running any of the examples, make sure your graphics drivers are up-to-date. If the issues persist, please report them to the authors of the libraries directly!

        [the `wgpu` examples]: https://github.com/gfx-rs/wgpu/tree/trunk/examples
        [the `glow` examples]: https://github.com/grovesNL/glow/tree/main/examples
      options:
      - label: My hardware is compatible and my graphics drivers are up-to-date.
        required: true
  - type: textarea
    attributes:
      label: What happened?
      id: what-happened
      description: |
        What problem are you having? Please, also provide the steps to reproduce it.

        If the issue happens with a particular program, please share an [SSCCE].

        [SSCCE]: http://sscce.org/
    validations:
      required: true
  - type: textarea
    attributes:
      label: What is the expected behavior?
      id: what-expected
      description: What were you expecting to happen?
    validations:
      required: true
  - type: dropdown
    id: version
    attributes:
      label: Version
      description: |
        We only offer support for the latest release on crates.io and the `master` branch on this repository. Which version are you using? Please make sure you are using the latest patch available (e.g. run `cargo update`).

        If you are using an older release, please upgrade to the latest one before filing an issue.
      options:
        - crates.io release
        - master
    validations:
      required: true
  - type: dropdown
    id: os
    attributes:
      label: Operating System
      description: Which operating system are you using?
      options:
        - Windows
        - macOS
        - Linux
    validations:
      required: true
  - type: textarea
    id: logs
    attributes:
      label: Do you have any log output?
      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
      render: shell