aboutsummaryrefslogtreecommitdiffstats
path: root/.github/ISSUE_TEMPLATE/recipe_request.yml
diff options
context:
space:
mode:
authorLibravatar Nathanaƫl Houn <contact@nathanaelhoun.fr>2023-02-15 20:05:34 +0100
committerLibravatar Vijay Aravamudhan <vraravam@users.noreply.github.com>2023-02-16 09:40:30 +0530
commit362282fe801c9994eae4b6518550beca9c806d0b (patch)
tree8439d361e904dc0be7345d7ad15d9833d74baa14 /.github/ISSUE_TEMPLATE/recipe_request.yml
parentdocs: reorder issues templates (diff)
downloadferdium-app-362282fe801c9994eae4b6518550beca9c806d0b.tar.gz
ferdium-app-362282fe801c9994eae4b6518550beca9c806d0b.tar.zst
ferdium-app-362282fe801c9994eae4b6518550beca9c806d0b.zip
docs: fix dead links
Diffstat (limited to '.github/ISSUE_TEMPLATE/recipe_request.yml')
-rw-r--r--.github/ISSUE_TEMPLATE/recipe_request.yml16
1 files changed, 6 insertions, 10 deletions
diff --git a/.github/ISSUE_TEMPLATE/recipe_request.yml b/.github/ISSUE_TEMPLATE/recipe_request.yml
index 9380fff29..e87a62c63 100644
--- a/.github/ISSUE_TEMPLATE/recipe_request.yml
+++ b/.github/ISSUE_TEMPLATE/recipe_request.yml
@@ -5,27 +5,23 @@ body:
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 "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 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. 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 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/ferdium/ferdium-recipes#importing-recipes-from-github. After adding the recipe, please create a PR back to this repository. 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 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. 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
18 1. Please remember to read the [self-help documentation](https://github.com/ferdium/ferdium-app#troubleshooting-recipes-self-help) - in case it helps you unblock yourself for issues related to old recipes.
19- type: checkboxes 17- type: checkboxes
20 attributes: 18 attributes:
21 label: Preflight Checklist 19 label: Preflight Checklist
22 description: Please ensure you've completed all of the following. 20 description: Please ensure you've completed all of the following.
23 options: 21 options:
24 - label: I have read the [Contributing Guidelines](https://github.com/ferdium/ferdium-recipes/blob/develop/CONTRIBUTING.md) for Ferdium Recipes. 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.
25 required: true
26 - label: I agree to follow the [Code of Conduct](https://github.com/ferdium/ferdium-recipes/blob/develop/CODE_OF_CONDUCT.md) that Ferdium Recipes adheres to.
27 required: true 23 required: true
28 - label: I have searched the [issue tracker](https://github.com/ferdium/ferdium-app/issues) for a recipes 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.
29 required: true 25 required: true
30- type: input 26- type: input
31 attributes: 27 attributes: