Revamped github Issue templates (new yml syntax) [skip ci]

6 files changed, 158 insertions, 68 deletions

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
deleted file mode 100644
index dd84ea7..0000000
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
@@ -1,38 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
-
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
-
-**Additional context**
-Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 0000000..9f9ecee
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,83 @@
+name: Bug Report
+description: Report an Ferdi bug
+title: "[Bug]: "
+labels: ["bug :beetle:"]
+body:
+- type: markdown
+  attributes:
+    value: |
+      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)
+      2. If you are requesting support for a new service in Ferdi, please log it [here](https://github.com/getferdi/recipes/issues/new/choose)
+      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.
+      4. Please fill our form below, this way we can analyse and fix the problem as fast as possible.
+      5. Please consider supporting Ferdi!
+        👉  https://github.com/sponsors/getferdi
+        👉  https://opencollective.com/getferdi/donate
+- type: checkboxes
+  attributes:
+    label: Preflight Checklist
+    description: Please ensure you've completed all of the following.
+    options:
+      - label: I have read the [Contributing Guidelines](https://github.com/getferdi/recipes/blob/develop/CONTRIBUTING.md) for this project.
+        required: true
+      - label: I agree to follow the [Code of Conduct](https://github.com/getferdi/recipes/blob/develop/CODE_OF_CONDUCT.md) that this project adheres to.
+        required: true
+      - label: I have searched the [issue tracker](https://github.com/getferdi/recipes/issues) for a feature request that matches the one I want to file, without success.
+        required: true
+- type: input
+  attributes:
+    label: Ferdi Version
+    description: What version of Ferdi are you using?
+    placeholder: 5.6.3
+  validations:
+    required: true
+- type: input
+  attributes:
+    label: Recipe Name
+    description: What is the name of the specific recipe you are using?
+    placeholder: 1.0.0
+  validations:
+    required: true
+- type: input
+  attributes:
+    label: Recipe Version
+    description: What version of the specific recipe are you using?
+    placeholder: 1.0.0
+  validations:
+    required: true
+- type: input
+  attributes:
+    label: Last Known working version of the recipe
+    description: What is the last version of the recipe this worked in, if applicable?
+    placeholder: 1.0.0
+- type: textarea
+  attributes:
+    label: Steps to reproduce
+    description: Explain to us how we can reproduce your bug on our computer
+    placeholder: |
+      1. Go to '...'
+      2. Click on '....'
+      3. Scroll down to '....'
+      4. See error
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Expected Behavior
+    description: A clear and concise description of what you expected to happen.
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Actual Behavior
+    description: A clear description of what actually happens.
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Screenshots
+    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
+- type: textarea
+  attributes:
+    label: Additional Information
+    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
index 3ba13e0..69c5789 100644
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -1 +1,5 @@
-blank_issues_enabled: false
+# blank_issues_enabled: false
+contact_links:
+  - name: Ferdi Community Support
+    url: https://help.getferdi.com/
+    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/open_issue.yml b/.github/ISSUE_TEMPLATE/open_issue.yml
new file mode 100644
index 0000000..d65a040
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/open_issue.yml
@@ -0,0 +1,11 @@
+name: Open issue
+description: For everything that's neither a new service request, nor a bug
+body:
+- type: markdown
+  attributes:
+    value: |
+      1. 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.
+      2. Please fill our form below, this way we can analyse and fix the problem as fast as possible.
+      3. Please consider supporting Ferdi!
+        👉  https://github.com/sponsors/getferdi
+        👉  https://opencollective.com/getferdi/donate
diff --git a/.github/ISSUE_TEMPLATE/recipe_request.md b/.github/ISSUE_TEMPLATE/recipe_request.md
deleted file mode 100644
index 65bf7a9..0000000
--- a/.github/ISSUE_TEMPLATE/recipe_request.md
+++ /dev/null
@@ -1,29 +0,0 @@
----
-name: A Recipe Request
-about: Suggest a service that we should add to Ferdi
-title: '<SERVICE>'
-labels: 'recipe request'
-assignees: ''
-
----
-<!--
-Before creating a new recipe request please check if you can add it yourself.
-If you add a recipe yourself it will be added faster than having to go through other contributors to do this job for you.
-
-As a first option to adding a service we recommend you search if someone already created such a recipe. For this, please search for your service name plus "Franz" on Github (e.g "WhatsApp Franz"), optionally you can also add "recipe" to the search query (e.g. "WhatsApp Franz recipe"). If you find a recipe (e.g. https://github.com/meetfranz/recipe-whatsapp), please check that its license allows us to add it to the repository. For this, open the "package.json" file of the project and look at the specified license. In most cases this will be '"license": "MIT"': The MIT License allows us to add the recipe! Please also check that the recipe is working (e.g. by adding it as a dev recipe to your Ferdi installation or looking if there are existing issues on the repository) and that it contains your desired features (e.g. look at the README). Another good indicator for if the recipe supports notifications is if there is code inside the "webview.js" file.
-After finding a recipe you can let our fetch script add it to the repository for you. For this, please fork this repository on GitHub and follow the instructions on https://github.com/getferdi/recipes#importing-recipes-from-github. After adding the recipe, please create a PR back to this repository.
-
-If there is no repository on GitHub you can also create one yourself - this often only takes 10-20 minutes and makes it much more likely that your service will get added! To create a recipe please look at this guide from Franz: https://github.com/meetfranz/plugins/blob/master/docs/integration.md.
-
-IF YOU ARE NOT FAMILIAR WITH JAVASCRIPT: Please still search for a recipe using the guide above and add it to your request.
--->
-
-<!-- Please complete the following form to create your recipe request: -->
-Name of the service (e.g. WhatsApp):
-URL of the service (e.g. whatsapp.com):
-
-GitHub URL to a recipe <!-- (optional but highly recommended. Please look at the intructions above)  -->: https://github.com/...
-
-Features you want implemented (optional):
-<!-- In this list you can write features you want this service to support, e.g. Notification support -->
--
diff --git a/.github/ISSUE_TEMPLATE/service_recipe_request.yml b/.github/ISSUE_TEMPLATE/service_recipe_request.yml
new file mode 100644
index 0000000..fda7f60
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/service_recipe_request.yml
@@ -0,0 +1,59 @@
+name: New Service-recipe Request
+description: Suggest a service that we should add to Ferdi
+title: "[Recipe Request]: "
+labels: ["recipe request :sparkles:"]
+body:
+- type: markdown
+  attributes:
+    value: |
+      Before creating a new recipe request please check if you can add it yourself.
+      If you add a recipe yourself it will be added faster than having to go through other contributors to do this job for you.
+
+      As a first option to adding a service we recommend you search if someone already created such a recipe. For this, please search for your service name plus "Franz" on Github (e.g "WhatsApp Franz"), optionally you can also add "recipe" to the search query (e.g. "WhatsApp Franz recipe"). If you find a recipe (e.g. https://github.com/meetfranz/recipe-whatsapp), please check that its license allows us to add it to the repository. For this, open the "package.json" file of the project and look at the specified license. In most cases this will be '"license": "MIT"': The MIT License allows us to add the recipe! Please also check that the recipe is working (e.g. by adding it as a dev recipe to your Ferdi installation or looking if there are existing issues on the repository) and that it contains your desired features (e.g. look at the README). Another good indicator for if the recipe supports notifications is if there is code inside the "webview.js" file.
+      After finding a recipe you can let our fetch script add it to the repository for you. For this, please fork this repository on GitHub and follow the instructions on https://github.com/getferdi/recipes#importing-recipes-from-github. After adding the recipe, please create a PR back to this repository.
+
+      If there is no repository on GitHub you can also create one yourself - this often only takes 10-20 minutes and makes it much more likely that your service will get added! To create a recipe please look at this guide from Franz: https://github.com/meetfranz/plugins/blob/master/docs/integration.md.
+
+      IF YOU ARE NOT FAMILIAR WITH JAVASCRIPT: Please still search for a recipe using the guide above and add it to your request.
+
+      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)
+      2. If you are requesting support for a new service in Ferdi, please log it [here](https://github.com/getferdi/recipes/issues/new/choose)
+      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.
+      4. Please fill our form below, this way we can analyse and fix the problem as fast as possible.
+      5. Please consider supporting Ferdi!
+        👉  https://github.com/sponsors/getferdi
+        👉  https://opencollective.com/getferdi/donate
+- type: checkboxes
+  attributes:
+    label: Preflight Checklist
+    description: Please ensure you've completed all of the following.
+    options:
+      - label: I have read the [Contributing Guidelines](https://github.com/getferdi/recipes/blob/develop/CONTRIBUTING.md) for this project.
+        required: true
+      - label: I agree to follow the [Code of Conduct](https://github.com/getferdi/recipes/blob/develop/CODE_OF_CONDUCT.md) that this project adheres to.
+        required: true
+      - label: I have searched the [issue tracker](https://github.com/getferdi/recipes/issues) for a feature request that matches the one I want to file, without success.
+        required: true
+- type: input
+  attributes:
+    label: Name of the service
+    description: What is the name of the service you are requesting?
+    placeholder: WhatsApp
+  validations:
+    required: true
+- type: input
+  attributes:
+    label: URL of the service
+    description: What is the URL of the service you are requesting?
+    placeholder: https://web.whatsapp.com
+- type: input
+  attributes:
+    label: GitHub URL to a recipe that has already been created by someone else or you
+    description: What is the URL of the service-recipe?
+    placeholder: https://github.com/...
+- type: textarea
+  attributes:
+    label: Features you want implemented
+    description: A clear and concise description of what features you want implemented eg Notification support
+  validations:
+    required: true