From 18801ed0c02627e87639dc0848cab44dacc18be2 Mon Sep 17 00:00:00 2001 From: Vijay A Date: Mon, 18 Apr 2022 06:51:50 -0500 Subject: Rebranded from 'ferdi' to 'ferdium' (companion changes for the main repo PR #2) --- .github/ISSUE_TEMPLATE/bug_report.yml | 8 ++++---- .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/ISSUE_TEMPLATE/service_recipe_request.yml | 6 +++--- .github/PULL_REQUEST_TEMPLATE/add_recipe.md | 4 ++-- .github/workflows/builds.yml | 2 +- 5 files changed, 11 insertions(+), 11 deletions(-) (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index d85264d..422f8d9 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,5 +1,5 @@ name: Bug Report -description: Report an Ferdi bug +description: Report an Ferdium bug title: "[Bug]: " labels: ["bug :beetle:"] body: @@ -7,7 +7,7 @@ body: attributes: value: | 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/ferdium/ferdium-recipes/issues) - 2. If you are requesting support for a new service in Ferdi, please log it [here](https://github.com/ferdium/ferdium-recipes/issues/new/choose) + 2. If you are requesting support for a new service in Ferdium, please log it [here](https://github.com/ferdium/ferdium-recipes/issues/new/choose) 3. 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. 4. Please fill our form below, this way we can analyse and fix the problem as fast as possible. - type: checkboxes @@ -23,8 +23,8 @@ body: required: true - type: input attributes: - label: Ferdi Version - description: What version of Ferdi are you using? + label: Ferdium Version + description: What version of Ferdium are you using? placeholder: 5.6.3 validations: required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 9018c02..dba8679 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,5 @@ # blank_issues_enabled: false contact_links: - - name: Ferdi Community Support + - name: Ferdium Community Support url: https://ferdium.org/faq/ about: Please see some basic questions here. If your question is not answered, please continue with raising an issue in github. diff --git a/.github/ISSUE_TEMPLATE/service_recipe_request.yml b/.github/ISSUE_TEMPLATE/service_recipe_request.yml index d984c2a..517d4ff 100644 --- a/.github/ISSUE_TEMPLATE/service_recipe_request.yml +++ b/.github/ISSUE_TEMPLATE/service_recipe_request.yml @@ -1,5 +1,5 @@ name: New Service-recipe Request -description: Suggest a service that we should add to Ferdi +description: Suggest a service that we should add to Ferdium title: "[Recipe Request]: " labels: ["recipe request :sparkles:"] body: @@ -9,7 +9,7 @@ body: Before creating a new recipe request please check if you can add it yourself. If you add a recipe yourself it will be added faster than having to go through other contributors to do this job for you. - 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. + 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. 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. 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,7 +17,7 @@ body: IF YOU ARE NOT FAMILIAR WITH JAVASCRIPT: Please still search for a recipe using the guide above and add it to your request. 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/ferdium/ferdium-recipes/issues) - 2. If you are requesting support for a new service in Ferdi, please log it [here](https://github.com/ferdium/ferdium-recipes/issues/new/choose) + 2. If you are requesting support for a new service in Ferdium, please log it [here](https://github.com/ferdium/ferdium-recipes/issues/new/choose) 3. 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. 4. Please fill our form below, this way we can analyse and fix the problem as fast as possible. - type: checkboxes diff --git a/.github/PULL_REQUEST_TEMPLATE/add_recipe.md b/.github/PULL_REQUEST_TEMPLATE/add_recipe.md index 1dd0379..0e35310 100644 --- a/.github/PULL_REQUEST_TEMPLATE/add_recipe.md +++ b/.github/PULL_REQUEST_TEMPLATE/add_recipe.md @@ -1,5 +1,5 @@ @@ -23,6 +23,6 @@ Service ID: [What ID does your recipe use?] - [ ] I am the original creator of this package - [ ] I have run the `pnpm run package` and verified that there are no validation errors reported for this package -- [ ] My recipe has been tested to work inside Ferdi +- [ ] My recipe has been tested to work inside Ferdium diff --git a/.github/workflows/builds.yml b/.github/workflows/builds.yml index 8feb1d9..77c2862 100644 --- a/.github/workflows/builds.yml +++ b/.github/workflows/builds.yml @@ -19,7 +19,7 @@ on: jobs: build: - name: Ferdi Recipes Build + name: Ferdium Recipes Build runs-on: ubuntu-latest steps: - name: Print latest commit -- cgit v1.2.3-54-g00ecf