blob: 000b36286197d94d6d1f2e4de363c536a109a942 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
|
# How to update/change recipes
If you want to improve or update an existing recipe, please follow this guide.
## 1. Implement your updates
We highly suggest that you implement and test your updates to the recipe inside Ferdi before implementing them into the recipe repository. This will save you time on debugging and repackaging the recipe later.
You can find the recipe source Ferdi uses at:
* Mac: `~/Library/Application Support/Ferdi/recipes/<recipe id>/`
* Windows: `%appdata%/Ferdi/recipes/<recipe id>/`
* Linux: `~/.config/Ferdi/recipes/<recipe id>`
> If you can't find the recipe's folder, please make sure that you have created a service inside Ferdi with that recipe - otherwise Ferdi will not load it into the folder
After changing the files in that folder, you can reload the service inside Ferdi using `CTRL/CMD + R`.
## 2. Setting up the recipe repository
Simply fork https://github.com/getferdi/recipes. You may also want to clone the repository to your computer to edit it locally.
## 3. Updating the recipe inside the repository
Simply add your changes to the recipe inside this repository.
## 4. Updating the version number
This might be the __most important step__ of this guide. You'll need to increase the version number inside recipe's `package.json`.
Ferdi uses this version to determine if it should update the local copy of the recipe. If you do not increase the version number, no Ferdi user will get your updated recipe 😔
## 5. Commit your changes and create a PR to <https://github.com/getferdi/recipes>
|
