aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLibravatar Nathanaƫl Houn <contact@nathanaelhoun.fr>2023-02-15 20:06:10 +0100
committerLibravatar Vijay Aravamudhan <vraravam@users.noreply.github.com>2023-02-16 09:40:30 +0530
commitdef8011dc39b5f05a81336d257ce65b6338102ce (patch)
treec15be3a03702effb01eb01217f6871ea5cc5e01b
parentdocs: fix dead links (diff)
downloadferdium-app-def8011dc39b5f05a81336d257ce65b6338102ce.tar.gz
ferdium-app-def8011dc39b5f05a81336d257ce65b6338102ce.tar.zst
ferdium-app-def8011dc39b5f05a81336d257ce65b6338102ce.zip
chore: issue templates formatting
-rw-r--r--.github/ISSUE_TEMPLATE/recipe_bug_report.yml142
-rw-r--r--.github/ISSUE_TEMPLATE/recipe_request.yml82
2 files changed, 112 insertions, 112 deletions
diff --git a/.github/ISSUE_TEMPLATE/recipe_bug_report.yml b/.github/ISSUE_TEMPLATE/recipe_bug_report.yml
index c02382866..3cf7cfe80 100644
--- a/.github/ISSUE_TEMPLATE/recipe_bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/recipe_bug_report.yml
@@ -2,74 +2,74 @@ name: Recipes - Bug Report
2description: Report a bug in a Ferdium Recipe for a particular service 2description: Report a bug in a Ferdium Recipe for a particular service
3labels: ["bug :beetle:", "recipe :bookmark_tabs:"] 3labels: ["bug :beetle:", "recipe :bookmark_tabs:"]
4body: 4body:
5- type: markdown 5 - type: markdown
6 attributes: 6 attributes:
7 value: | 7 value: |
8 1. Please fill our form below, this way we can analyse and fix the problem as fast as possible. 8 1. Please fill our form below, this way we can analyse and fix the problem as fast as possible.
9 2. If you are adding screenshots and/or videos, please do add it in English so that a wider group of people can understand and help with resolution. 9 2. If you are adding screenshots and/or videos, please do add it in English so that a wider group of people can understand and help with resolution.
10- type: checkboxes 10 - type: checkboxes
11 attributes: 11 attributes:
12 label: Preflight Checklist 12 label: Preflight Checklist
13 description: Please ensure you've completed all of the following. 13 description: Please ensure you've completed all of the following.
14 options: 14 options:
15 - label: I agree to follow the [Code of Conduct](https://github.com/ferdium/ferdium-recipes/blob/HEAD/CODE_OF_CONDUCT.md) that Ferdium Recipes adheres to. 15 - label: I agree to follow the [Code of Conduct](https://github.com/ferdium/ferdium-recipes/blob/HEAD/CODE_OF_CONDUCT.md) that Ferdium Recipes adheres to.
16 required: true 16 required: true
17 - label: I have searched the [issue tracker](https://github.com/ferdium/ferdium-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22recipe+%3Abookmark_tabs%3A%22+label%3A%22bug+%3Abeetle%3A%22+) for a bug report that matches the one I want to file, without success. 17 - label: I have searched the [issue tracker](https://github.com/ferdium/ferdium-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22recipe+%3Abookmark_tabs%3A%22+label%3A%22bug+%3Abeetle%3A%22+) for a bug report that matches the one I want to file, without success.
18 required: true 18 required: true
19- type: input 19 - type: input
20 attributes: 20 attributes:
21 label: Ferdium Version 21 label: Ferdium Version
22 description: What version of Ferdium are you using? 22 description: What version of Ferdium are you using?
23 placeholder: 5.6.3 23 placeholder: 5.6.3
24 validations: 24 validations:
25 required: true 25 required: true
26- type: input 26 - type: input
27 attributes: 27 attributes:
28 label: Recipe Name 28 label: Recipe Name
29 description: What is the name of the specific recipe you are using? 29 description: What is the name of the specific recipe you are using?
30 placeholder: WhatsApp 30 placeholder: WhatsApp
31 validations: 31 validations:
32 required: true 32 required: true
33- type: input 33 - type: input
34 attributes: 34 attributes:
35 label: Recipe Version 35 label: Recipe Version
36 description: What version of the specific recipe are you using? 36 description: What version of the specific recipe are you using?
37 placeholder: 1.0.0 37 placeholder: 1.0.0
38 validations: 38 validations:
39 required: true 39 required: true
40- type: input 40 - type: input
41 attributes: 41 attributes:
42 label: Last Known working version of the recipe 42 label: Last Known working version of the recipe
43 description: What is the last version of the recipe this worked in, if applicable? 43 description: What is the last version of the recipe this worked in, if applicable?
44 placeholder: 1.0.0 44 placeholder: 1.0.0
45- type: textarea 45 - type: textarea
46 attributes: 46 attributes:
47 label: Steps to reproduce 47 label: Steps to reproduce
48 description: Explain to us how we can reproduce your bug on our computer 48 description: Explain to us how we can reproduce your bug on our computer
49 placeholder: | 49 placeholder: |
50 1. Go to '...' 50 1. Go to '...'
51 2. Click on '....' 51 2. Click on '....'
52 3. Scroll down to '....' 52 3. Scroll down to '....'
53 4. See error 53 4. See error
54 validations: 54 validations:
55 required: true 55 required: true
56- type: textarea 56 - type: textarea
57 attributes: 57 attributes:
58 label: Expected Behavior 58 label: Expected Behavior
59 description: A clear and concise description of what you expected to happen. 59 description: A clear and concise description of what you expected to happen.
60 validations: 60 validations:
61 required: true 61 required: true
62- type: textarea 62 - type: textarea
63 attributes: 63 attributes:
64 label: Actual Behavior 64 label: Actual Behavior
65 description: A clear description of what actually happens. 65 description: A clear description of what actually happens.
66 validations: 66 validations:
67 required: true 67 required: true
68- type: textarea 68 - type: textarea
69 attributes: 69 attributes:
70 label: Screenshots 70 label: Screenshots
71 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 71 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
72- type: textarea 72 - type: textarea
73 attributes: 73 attributes:
74 label: Additional Information 74 label: Additional Information
75 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. 75 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/recipe_request.yml b/.github/ISSUE_TEMPLATE/recipe_request.yml
index e87a62c63..c84b456f1 100644
--- a/.github/ISSUE_TEMPLATE/recipe_request.yml
+++ b/.github/ISSUE_TEMPLATE/recipe_request.yml
@@ -2,47 +2,47 @@ name: Recipes - New Service Request
2description: Suggest a service that we should add to Ferdium Recipes 2description: Suggest a service that we should add to Ferdium Recipes
3labels: ["recipe request :sparkles:", "recipe :bookmark_tabs:"] 3labels: ["recipe request :sparkles:", "recipe :bookmark_tabs:"]
4body: 4body:
5- type: markdown 5 - type: markdown
6 attributes: 6 attributes:
7 value: | 7 value: |
8 Before creating a new recipe request, please check if you can add it yourself. 8 Before creating a new recipe request, please check if you can add it yourself.
9 If you add a recipe yourself it will be added faster than having to go through other contributors to do this job for you. 9 If you add a recipe yourself it will be added faster than having to go through other contributors to do this job for you.
10 10
11 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 "Ferdium" or "Ferdi" on Github (e.g "WhatsApp Ferdium"), optionally you can also add "recipe" to the search query (e.g. "WhatsApp Ferdium recipe"). 11 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 "Ferdium" or "Ferdi" on Github (e.g "WhatsApp Ferdium"), optionally you can also add "recipe" to the search query (e.g. "WhatsApp Ferdium recipe").
12 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 Ferdium 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. 12 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 Ferdium 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.
13 13
14 If there is no existing recipe, 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 [our guide](https://github.com/ferdium/ferdium-recipes/blob/main/docs/integration.md). 14 If there is no existing recipe, 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 [our guide](https://github.com/ferdium/ferdium-recipes/blob/main/docs/integration.md).
15 15
16 IF YOU ARE NOT FAMILIAR WITH JAVASCRIPT: Please still search for a recipe using the guide above and add it to your request. 16 IF YOU ARE NOT FAMILIAR WITH JAVASCRIPT: Please still search for a recipe using the guide above and add it to your request.
17- type: checkboxes 17 - type: checkboxes
18 attributes: 18 attributes:
19 label: Preflight Checklist 19 label: Preflight Checklist
20 description: Please ensure you've completed all of the following. 20 description: Please ensure you've completed all of the following.
21 options: 21 options:
22 - label: I agree to follow the [Code of Conduct](https://github.com/ferdium/ferdium-recipes/blob/HEAD/CODE_OF_CONDUCT.md) that Ferdium Recipes adheres to. 22 - label: I agree to follow the [Code of Conduct](https://github.com/ferdium/ferdium-recipes/blob/HEAD/CODE_OF_CONDUCT.md) that Ferdium Recipes adheres to.
23 required: true 23 required: true
24 - label: I have searched the [issue tracker](https://github.com/ferdium/ferdium-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22recipe+request+%3Asparkles%3A%22) for a recipe request that matches the one I want to file, without success. 24 - label: I have searched the [issue tracker](https://github.com/ferdium/ferdium-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22recipe+request+%3Asparkles%3A%22) for a recipe request that matches the one I want to file, without success.
25 required: true 25 required: true
26- type: input 26 - type: input
27 attributes: 27 attributes:
28 label: Name of the service 28 label: Name of the service
29 description: What is the name of the service you are requesting? 29 description: What is the name of the service you are requesting?
30 placeholder: WhatsApp 30 placeholder: WhatsApp
31 validations: 31 validations:
32 required: true 32 required: true
33- type: input 33 - type: input
34 attributes: 34 attributes:
35 label: URL of the service 35 label: URL of the service
36 description: What is the URL of the service you are requesting? 36 description: What is the URL of the service you are requesting?
37 placeholder: https://web.whatsapp.com 37 placeholder: https://web.whatsapp.com
38- type: input 38 - type: input
39 attributes: 39 attributes:
40 label: GitHub URL to a recipe that has already been created by someone else or you 40 label: GitHub URL to a recipe that has already been created by someone else or you
41 description: What is the URL of the service-recipe? 41 description: What is the URL of the service-recipe?
42 placeholder: https://github.com/... 42 placeholder: https://github.com/...
43- type: textarea 43 - type: textarea
44 attributes: 44 attributes:
45 label: Features you want implemented 45 label: Features you want implemented
46 description: A clear and concise description of what features you want implemented eg Notification support 46 description: A clear and concise description of what features you want implemented eg Notification support
47 validations: 47 validations:
48 required: true 48 required: true