diff options
Diffstat (limited to '.github/ISSUE_TEMPLATE/bug_report.yml')
-rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.yml | 121 |
1 files changed, 121 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..8ca304efb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml | |||
@@ -0,0 +1,121 @@ | |||
1 | name: Bug Report | ||
2 | description: Report an Ferdi bug | ||
3 | title: "[Bug]: " | ||
4 | labels: "bug :beetle:" | ||
5 | body: | ||
6 | - type: markdown | ||
7 | attributes: | ||
8 | value: | | ||
9 | 1. Please remember that if you are logging a bug for some service that has *stopped working*, please log the bug [here](https://github.com/getferdi/recipes/issues) | ||
10 | 2. If you are requesting support for a new service in Ferdi, please log it [here](https://github.com/getferdi/recipes/pulls) | ||
11 | 3. Please remember to read the [self-help documentation](https://github.com/getferdi/ferdi#troubleshooting-recipes-self-help) - in case it helps you unblock yourself for issues related to old recipes. | ||
12 | 4. Please fill our form below, this way we can analyse and fix the problem as fast as possible. | ||
13 | 5. Please consider supporting Ferdi! | ||
14 | 👉 https://github.com/sponsors/getferdi | ||
15 | 👉 https://opencollective.com/getferdi/donate | ||
16 | - type: checkboxes | ||
17 | attributes: | ||
18 | label: Preflight Checklist | ||
19 | description: Please ensure you've completed all of the following. | ||
20 | options: | ||
21 | - label: I have read the [Contributing Guidelines](https://github.com/getferdi/ferdi/blob/develop/CONTRIBUTING.md) for this project. | ||
22 | required: true | ||
23 | - label: I agree to follow the [Code of Conduct](https://github.com/getferdi/ferdi/blob/develop/CODE_OF_CONDUCT.md) that this project adheres to. | ||
24 | required: true | ||
25 | - label: I have searched the [issue tracker](https://github.com/getferdi/ferdi/issues) for a feature request that matches the one I want to file, without success. | ||
26 | required: true | ||
27 | - type: input | ||
28 | attributes: | ||
29 | label: Ferdi Version | ||
30 | description: What version of Ferdi are you using? | ||
31 | placeholder: 5.5.0 | ||
32 | validations: | ||
33 | required: true | ||
34 | - type: dropdown | ||
35 | attributes: | ||
36 | label: What operating system are you using? | ||
37 | options: | ||
38 | - Windows | ||
39 | - macOS | ||
40 | - Ubuntu | ||
41 | - Other Linux | ||
42 | - Other (specify below) | ||
43 | validations: | ||
44 | required: true | ||
45 | - type: dropdown | ||
46 | attributes: | ||
47 | label: Server | ||
48 | options: | ||
49 | - Ferdi | ||
50 | - Franz | ||
51 | - Using without an account | ||
52 | - Other server (please specify in the steps to reproduce) | ||
53 | validations: | ||
54 | required: true | ||
55 | - type: input | ||
56 | attributes: | ||
57 | label: Operating System Version | ||
58 | description: What operating system version are you using? On Windows, click Start button > Settings > System > About. On macOS, click the Apple Menu > About This Mac. On Linux, inside a terminal session, use lsb_release or uname -a. | ||
59 | placeholder: "e.g. Windows 10 version 1909, macOS Catalina 10.15.7, or Ubuntu 20.04" | ||
60 | validations: | ||
61 | required: true | ||
62 | - type: dropdown | ||
63 | attributes: | ||
64 | label: What arch are you using? | ||
65 | options: | ||
66 | - x64 | ||
67 | - ia32 | ||
68 | - arm64 (including Apple Silicon) | ||
69 | - Other (specify below) | ||
70 | validations: | ||
71 | required: true | ||
72 | - type: input | ||
73 | attributes: | ||
74 | label: Last Known working version of Ferdi | ||
75 | description: What is the last version of Ferdi this worked in, if applicable? | ||
76 | placeholder: 5.5.0 | ||
77 | - type: input | ||
78 | attributes: | ||
79 | label: Git SHA and/or build date | ||
80 | description: In the latest versions of Ferdi, we now also expose the GIT SHA and the build date. IF you are running one such version, please include this information as well. | ||
81 | placeholder: 9b29f041 / Sun May 09 2021 12:35:48 GMT+0200 | ||
82 | - type: textarea | ||
83 | attributes: | ||
84 | label: Steps to reproduce | ||
85 | description: Explain to us how we can reproduce your bug on our computer | ||
86 | placeholder: | | ||
87 | 1. Go to '...' | ||
88 | 2. Click on '....' | ||
89 | 3. Scroll down to '....' | ||
90 | 4. See error | ||
91 | validations: | ||
92 | required: true | ||
93 | - type: textarea | ||
94 | attributes: | ||
95 | label: Expected Behavior | ||
96 | description: A clear and concise description of what you expected to happen. | ||
97 | validations: | ||
98 | required: true | ||
99 | - type: textarea | ||
100 | attributes: | ||
101 | label: Actual Behavior | ||
102 | description: A clear description of what actually happens. | ||
103 | validations: | ||
104 | required: true | ||
105 | - type: textarea | ||
106 | attributes: | ||
107 | label: Screenshots | ||
108 | description: If applicable, add screenshots to help explain your problem. You can simply drag and drop any image file into the editor to add it to the report | ||
109 | - type: textarea | ||
110 | attributes: | ||
111 | label: Debug information | ||
112 | description: Get your debug information via Ferdi "Help" menu ("Copy/Publish Debug Information") then share a debug information file or your published link with us. | ||
113 | - type: input | ||
114 | attributes: | ||
115 | label: Testcase Gist URL | ||
116 | description: If you can reproduce the issue in a standalone test case, please use [Electron Fiddle](https://github.com/electron/fiddle) to create one and to publish it as a [GitHub gist](https://gist.github.com) and put the gist URL here. This is **the best way** to ensure this issue is triaged quickly **and** does not regress in the future. | ||
117 | placeholder: https://gist.github.com/... | ||
118 | - type: textarea | ||
119 | attributes: | ||
120 | label: Additional Information | ||
121 | description: If your problem needs further explanation, or if the issue you're seeing cannot be reproduced in a gist, please add more information here. | ||