aboutsummaryrefslogtreecommitdiffstats
path: root/.github/ISSUE_TEMPLATE
diff options
context:
space:
mode:
authorLibravatar Vijay Aravamudhan <vraravam@users.noreply.github.com>2021-11-18 07:14:01 +0530
committerLibravatar GitHub <noreply@github.com>2021-11-18 07:14:01 +0530
commit9a03c8b8c3c1dbfb802a69105faa82dca4673934 (patch)
tree51a5c0b1101499b066b9077abec1eb62c84279e6 /.github/ISSUE_TEMPLATE
parent5.6.4-nightly.9 [skip ci] (diff)
downloadferdium-app-9a03c8b8c3c1dbfb802a69105faa82dca4673934.tar.gz
ferdium-app-9a03c8b8c3c1dbfb802a69105faa82dca4673934.tar.zst
ferdium-app-9a03c8b8c3c1dbfb802a69105faa82dca4673934.zip
Revamped github Issue templates (new yml syntax) [skip ci] (#1441)
Diffstat (limited to '.github/ISSUE_TEMPLATE')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md45
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.yml121
-rw-r--r--.github/ISSUE_TEMPLATE/config.yml5
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.md20
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.yml48
-rw-r--r--.github/ISSUE_TEMPLATE/open_issue.md8
-rw-r--r--.github/ISSUE_TEMPLATE/open_issue.yml13
7 files changed, 187 insertions, 73 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
deleted file mode 100644
index 020d6ff58..000000000
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
@@ -1,45 +0,0 @@
1---
2name: Bug report
3about: Create a report to help us improve
4---
5<!--
6Please remember that if you are logging a bug for some service that has *stopped working*, please log the bug at https://github.com/getferdi/recipes/issues
7Please remember to read the self-help documentation at https://github.com/getferdi/ferdi#troubleshooting-recipes-self-help - in case it helps you unblock yourself.
8
9Please fill our form below, this way we can analyse and fix the problem as fast as possible.
10
11Please keep in mind that any text inside "<!--" and "--\>" are comments from us and won't be visible in your bug report, so please don't put any text in them.
12-->
13**Bug description:**
14<!-- Add a clear and concise description of what the bug is -->
15
16**Steps to reproduce:**
17<!-- Explain to us how we can reproduce your bug on our computer -->
18
191. Go to '...'
202. Click on '....'
213. Scroll down to '....'
224. See error
23
24**Expected behavior**
25<!-- If applicable, add a description of what you expected to happen. -->
26
27**Screenshots**
28<!-- If applicable, add screenshots to help explain your problem. -->
29<!-- You can simply drag and drop any image file into the editor to add it to the report -->
30
31**Environment:**
32
33- Operating System: <!-- e.g. macOS Catalina, Windows 10, etc. -->
34- Ferdi Version: <!-- e.g. 5.4.3 -->
35- Server: <!-- e.g. Ferdi, Franz, Using without an account -->
36
37- Debug information:
38<!--
39Get your debug information via Ferdi "Help" menu ("Copy/Publish Debug Information") then
40share a debug information file or your published link with us.
41-->
42
43<!-- Please consider supporting Ferdi!
44👉 https://github.com/sponsors/getferdi
45👉 https://opencollective.com/getferdi/donate -->
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 @@
1name: Bug Report
2description: Report an Ferdi bug
3title: "[Bug]: "
4labels: "bug :beetle:"
5body:
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.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 000000000..69c57897d
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,5 @@
1# blank_issues_enabled: false
2contact_links:
3 - name: Ferdi Community Support
4 url: https://help.getferdi.com/
5 about: Please see some basic questions here. If your question is not answered, please continue with raising an issue in github.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
deleted file mode 100644
index 61353797c..000000000
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ /dev/null
@@ -1,20 +0,0 @@
1---
2name: Feature request
3about: Suggest an idea for this project
4---
5
6**Is your feature request related to a problem? Please describe.**
7A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
8
9**Describe the solution you'd like**
10A clear and concise description of what you want to happen.
11
12**Describe alternatives you've considered**
13A clear and concise description of any alternative solutions or features you've considered.
14
15**Additional context**
16Add any other context or screenshots about the feature request here.
17
18<!-- Please consider supporting Ferdi!
19👉 https://github.com/sponsors/getferdi
20👉 https://opencollective.com/getferdi/donate -->
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
new file mode 100644
index 000000000..3662edffd
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,48 @@
1name: Feature Request
2description: Suggest an idea for Ferdi
3title: "[Feature Request]: "
4labels: "enhancement :sparkles:"
5body:
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: textarea
28 attributes:
29 label: Problem Description
30 description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
31 validations:
32 required: true
33- type: textarea
34 attributes:
35 label: Proposed Solution
36 description: A clear and concise description of what you want to happen.
37 validations:
38 required: true
39- type: textarea
40 attributes:
41 label: Alternatives Considered
42 description: A clear and concise description of any alternative solutions or features you've considered.
43 validations:
44 required: true
45- type: textarea
46 attributes:
47 label: Additional Information
48 description: Add any other context or screenshots about the feature request here.
diff --git a/.github/ISSUE_TEMPLATE/open_issue.md b/.github/ISSUE_TEMPLATE/open_issue.md
deleted file mode 100644
index c7c279643..000000000
--- a/.github/ISSUE_TEMPLATE/open_issue.md
+++ /dev/null
@@ -1,8 +0,0 @@
1---
2name: Open issue
3about: For everything that's neither a feature request, nor a bug
4---
5
6<!-- Please consider supporting Ferdi!
7👉 https://github.com/sponsors/getferdi
8👉 https://opencollective.com/getferdi/donate -->
diff --git a/.github/ISSUE_TEMPLATE/open_issue.yml b/.github/ISSUE_TEMPLATE/open_issue.yml
new file mode 100644
index 000000000..947b94459
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/open_issue.yml
@@ -0,0 +1,13 @@
1name: Open issue
2description: For everything that's neither a feature request, nor a bug
3body:
4- type: markdown
5 attributes:
6 value: |
7 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)
8 2. If you are requesting support for a new service in Ferdi, please log it [here](https://github.com/getferdi/recipes/pulls)
9 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.
10 4. Please fill our form below, this way we can analyse and fix the problem as fast as possible.
11 5. Please consider supporting Ferdi!
12 👉 https://github.com/sponsors/getferdi
13 👉 https://opencollective.com/getferdi/donate