aboutsummaryrefslogtreecommitdiffstats
path: root/.github/ISSUE_TEMPLATE/service_recipe_request.yml
diff options
context:
space:
mode:
authorLibravatar Vijay A <vraravam@users.noreply.github.com>2021-11-18 08:34:27 +0530
committerLibravatar Vijay A <vraravam@users.noreply.github.com>2021-11-18 08:34:27 +0530
commitb4b3646e236ce9499117cc40a9ba1e9821c7d6e0 (patch)
treee5f83536ffde705f32a2b9e82920f4ccff253c6a /.github/ISSUE_TEMPLATE/service_recipe_request.yml
parentdon't use npm cache (since it breaks the CI builds randomly) (diff)
downloadferdium-recipes-b4b3646e236ce9499117cc40a9ba1e9821c7d6e0.tar.gz
ferdium-recipes-b4b3646e236ce9499117cc40a9ba1e9821c7d6e0.tar.zst
ferdium-recipes-b4b3646e236ce9499117cc40a9ba1e9821c7d6e0.zip
Revamped github Issue templates (new yml syntax) [skip ci]
Diffstat (limited to '.github/ISSUE_TEMPLATE/service_recipe_request.yml')
-rw-r--r--.github/ISSUE_TEMPLATE/service_recipe_request.yml59
1 files changed, 59 insertions, 0 deletions
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 @@
1name: New Service-recipe Request
2description: Suggest a service that we should add to Ferdi
3title: "[Recipe Request]: "
4labels: ["recipe request :sparkles:"]
5body:
6- type: markdown
7 attributes:
8 value: |
9 Before creating a new recipe request please check if you can add it yourself.
10 If you add a recipe yourself it will be added faster than having to go through other contributors to do this job for you.
11
12 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.
13 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.
14
15 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.
16
17 IF YOU ARE NOT FAMILIAR WITH JAVASCRIPT: Please still search for a recipe using the guide above and add it to your request.
18
19 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)
20 2. If you are requesting support for a new service in Ferdi, please log it [here](https://github.com/getferdi/recipes/issues/new/choose)
21 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.
22 4. Please fill our form below, this way we can analyse and fix the problem as fast as possible.
23 5. Please consider supporting Ferdi!
24 👉 https://github.com/sponsors/getferdi
25 👉 https://opencollective.com/getferdi/donate
26- type: checkboxes
27 attributes:
28 label: Preflight Checklist
29 description: Please ensure you've completed all of the following.
30 options:
31 - label: I have read the [Contributing Guidelines](https://github.com/getferdi/recipes/blob/develop/CONTRIBUTING.md) for this project.
32 required: true
33 - 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.
34 required: true
35 - 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.
36 required: true
37- type: input
38 attributes:
39 label: Name of the service
40 description: What is the name of the service you are requesting?
41 placeholder: WhatsApp
42 validations:
43 required: true
44- type: input
45 attributes:
46 label: URL of the service
47 description: What is the URL of the service you are requesting?
48 placeholder: https://web.whatsapp.com
49- type: input
50 attributes:
51 label: GitHub URL to a recipe that has already been created by someone else or you
52 description: What is the URL of the service-recipe?
53 placeholder: https://github.com/...
54- type: textarea
55 attributes:
56 label: Features you want implemented
57 description: A clear and concise description of what features you want implemented eg Notification support
58 validations:
59 required: true