diff options
author | 2020-01-23 14:38:29 +0100 | |
---|---|---|
committer | 2020-01-23 14:38:29 +0100 | |
commit | 21b0f6b67daea76cbddb187208150dbfdeb1d81f (patch) | |
tree | 25a566d5a97104a853e854b6ed9b3befd4806744 /.github/ISSUE_TEMPLATE/recipe_request.md | |
parent | #12 Add Google Drive Recipe (diff) | |
download | ferdium-recipes-21b0f6b67daea76cbddb187208150dbfdeb1d81f.tar.gz ferdium-recipes-21b0f6b67daea76cbddb187208150dbfdeb1d81f.tar.zst ferdium-recipes-21b0f6b67daea76cbddb187208150dbfdeb1d81f.zip |
Update recipe_request.md
Diffstat (limited to '.github/ISSUE_TEMPLATE/recipe_request.md')
-rw-r--r-- | .github/ISSUE_TEMPLATE/recipe_request.md | 23 |
1 files changed, 20 insertions, 3 deletions
diff --git a/.github/ISSUE_TEMPLATE/recipe_request.md b/.github/ISSUE_TEMPLATE/recipe_request.md index f8066e3..2df207d 100644 --- a/.github/ISSUE_TEMPLATE/recipe_request.md +++ b/.github/ISSUE_TEMPLATE/recipe_request.md | |||
@@ -6,8 +6,25 @@ labels: 'recipe request' | |||
6 | assignees: '' | 6 | assignees: '' |
7 | 7 | ||
8 | --- | 8 | --- |
9 | <!-- | ||
10 | Before creating a new recipe request please check if you can add it yourself. | ||
11 | If you add a recipe yourself it will be added faster than having to go through other contributors to do this job for you. | ||
12 | |||
13 | 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. | ||
14 | 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. | ||
15 | |||
16 | 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. | ||
17 | |||
18 | IF YOU ARE NOT FAMILIAR WITH JAVASCRIPT: Please still search for a recipe using the guide above and add it to your request. | ||
19 | --> | ||
20 | |||
21 | |||
9 | <!-- Please complete the following form to create your recipe request: --> | 22 | <!-- Please complete the following form to create your recipe request: --> |
10 | Name of the recipe: | 23 | Name of the service (e.g. WhatsApp): |
11 | URL of the recipe: | 24 | URL of the service (e.g. whatsapp.com): |
25 | |||
26 | GitHub URL to a recipe <!-- (optional but highly recommended. Please look at the intructions above) -->: https://github.com/... | ||
27 | |||
12 | Features you want implemented (optional): | 28 | Features you want implemented (optional): |
13 | - <!-- In this list you can write features you want this service to support, e.g. Notification support --> | 29 | <!-- In this list you can write features you want this service to support, e.g. Notification support --> |
30 | - | ||