From 933ee79769c257125eeba7f7e170e6b3ea6cf05a Mon Sep 17 00:00:00 2001 From: Nathanaël Houn Date: Wed, 15 Feb 2023 19:00:26 +0100 Subject: docs: add issues templates from recipes --- .github/ISSUE_TEMPLATE/app_bug_report.yml | 97 ++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/app_feature_request.yml | 46 ++++++++++++ .github/ISSUE_TEMPLATE/bug_report.yml | 97 -------------------------- .github/ISSUE_TEMPLATE/feature_request.yml | 46 ------------ .github/ISSUE_TEMPLATE/recipe_bug_report.yml | 80 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/recipe_request.yml | 56 +++++++++++++++ 6 files changed, 279 insertions(+), 143 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/app_bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/app_feature_request.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/recipe_bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/recipe_request.yml (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE/app_bug_report.yml b/.github/ISSUE_TEMPLATE/app_bug_report.yml new file mode 100644 index 000000000..a253adca4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/app_bug_report.yml @@ -0,0 +1,97 @@ +name: App Bug report +description: Report a bug in the Ferdium App +title: "Bug: " +labels: ["bug :beetle:"] +body: + - type: markdown + 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 Ferdium, please log it [here](https://github.com/ferdium/ferdium-recipes/pulls) + 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. If you are adding screenshots and/or videos, please do add it in English so that a wider group of people can understand and help with resolution. + 5. Please fill our form below, this way we can analyse and fix the problem as fast as possible. + - type: checkboxes + attributes: + label: Avoid duplicates + description: Please ensure you've completed the following + options: + - label: I have searched the [issues tracker](https://github.com/ferdium/ferdium-app/issues) for a bug report similar to mine, in vain + required: true + - type: input + attributes: + label: Ferdium Version + description: What version of Ferdium are you using? + placeholder: 6.0.0-nightly.7 + validations: + required: true + - type: dropdown + attributes: + label: What Operating System are you using? + options: + - Windows + - macOS + - Ubuntu + - Other Linux + - Other (specify below) + validations: + required: true + - type: input + attributes: + label: Operating System Version + description: What Operating System version are you using? On Windows, click Start button > Settings > System > About. On macOS, click the Apple Menu > About This Mac. On Linux, use lsb_release or uname -a. + placeholder: "e.g. Windows 10 version 1909, macOS Catalina 10.15.7, or Ubuntu 20.04" + validations: + required: true + - type: dropdown + attributes: + label: What arch are you using? + options: + - x64 + - ia32 + - arm64 (including Apple Silicon) + - Other (specify in Additional information section) + validations: + required: true + - type: input + attributes: + label: Last Known Working Ferdium version + description: What is the last version of Ferdium this worked in, if applicable? + placeholder: 6.0.0-nightly.7 + - type: textarea + attributes: + label: Expected Behavior + description: A clear and concise description of what you expected to happen. + validations: + required: true + - type: textarea + attributes: + label: Actual Behavior + description: A clear description of what actually happens. + validations: + required: true + - type: textarea + attributes: + label: Steps to reproduce + description: Explain to us how we can reproduce your bug on our computer + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: true + - type: input + attributes: + label: Debug link + description: Please get your debug link via Ferdium's "Help" > "Publish Debug Information", then share your link with us + validations: + required: false + - type: textarea + attributes: + label: Screenshots + description: If applicable, add screenshots to help visualize your problem + - type: textarea + attributes: + label: Additional information + description: If your problem needs further explanation, please add more information here diff --git a/.github/ISSUE_TEMPLATE/app_feature_request.yml b/.github/ISSUE_TEMPLATE/app_feature_request.yml new file mode 100644 index 000000000..e10512398 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/app_feature_request.yml @@ -0,0 +1,46 @@ +name: Feature Request +description: Suggest an idea for Ferdium +title: "Feature: " +labels: ["enhancement :sparkles:"] +body: + - type: markdown + 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 Ferdium, please log it [here](https://github.com/ferdium/ferdium-recipes/pulls) + 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. If you are adding screenshots and/or videos, please do add it in English so that a wider group of people can understand and help with resolution. + 5. Please fill our form below, this way we can analyse and fix the problem as fast as possible. + - type: checkboxes + attributes: + label: Preflight Checklist + description: Please ensure you've completed all of the following. + options: + - label: I have read the [Contributing Guidelines](https://github.com/ferdium/ferdium-app/blob/develop/CONTRIBUTING.md) for this project. + required: true + - label: I agree to follow the [Code of Conduct](https://github.com/ferdium/ferdium-app/blob/develop/CODE_OF_CONDUCT.md) that this project adheres to. + required: true + - label: I have searched the [issue tracker](https://github.com/ferdium/ferdium-app/issues) for a feature request that matches the one I want to file, without success. + required: true + - type: textarea + attributes: + label: Problem Description + description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + validations: + required: true + - type: textarea + attributes: + label: Proposed Solution + description: A clear and concise description of what you want to happen. + validations: + required: true + - type: textarea + attributes: + label: Alternatives Considered + description: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: true + - type: textarea + attributes: + label: Additional Information + description: Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml deleted file mode 100644 index 264f94ef3..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ /dev/null @@ -1,97 +0,0 @@ -name: Bug report -description: Report a bug in Ferdium -title: "Bug: " -labels: ["bug :beetle:"] -body: - - type: markdown - 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 Ferdium, please log it [here](https://github.com/ferdium/ferdium-recipes/pulls) - 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. If you are adding screenshots and/or videos, please do add it in English so that a wider group of people can understand and help with resolution. - 5. Please fill our form below, this way we can analyse and fix the problem as fast as possible. - - type: checkboxes - attributes: - label: Avoid duplicates - description: Please ensure you've completed the following - options: - - label: I have searched the [issues tracker](https://github.com/ferdium/ferdium-app/issues) for a bug report similar to mine, in vain - required: true - - type: input - attributes: - label: Ferdium Version - description: What version of Ferdium are you using? - placeholder: 6.0.0-nightly.7 - validations: - required: true - - type: dropdown - attributes: - label: What Operating System are you using? - options: - - Windows - - macOS - - Ubuntu - - Other Linux - - Other (specify below) - validations: - required: true - - type: input - attributes: - label: Operating System Version - description: What Operating System version are you using? On Windows, click Start button > Settings > System > About. On macOS, click the Apple Menu > About This Mac. On Linux, use lsb_release or uname -a. - placeholder: "e.g. Windows 10 version 1909, macOS Catalina 10.15.7, or Ubuntu 20.04" - validations: - required: true - - type: dropdown - attributes: - label: What arch are you using? - options: - - x64 - - ia32 - - arm64 (including Apple Silicon) - - Other (specify in Additional information section) - validations: - required: true - - type: input - attributes: - label: Last Known Working Ferdium version - description: What is the last version of Ferdium this worked in, if applicable? - placeholder: 6.0.0-nightly.7 - - type: textarea - attributes: - label: Expected Behavior - description: A clear and concise description of what you expected to happen. - validations: - required: true - - type: textarea - attributes: - label: Actual Behavior - description: A clear description of what actually happens. - validations: - required: true - - type: textarea - attributes: - label: Steps to reproduce - description: Explain to us how we can reproduce your bug on our computer - placeholder: | - 1. Go to '...' - 2. Click on '....' - 3. Scroll down to '....' - 4. See error - validations: - required: true - - type: input - attributes: - label: Debug link - description: Please get your debug link via Ferdium's "Help" > "Publish Debug Information", then share your link with us - validations: - required: false - - type: textarea - attributes: - label: Screenshots - description: If applicable, add screenshots to help visualize your problem - - type: textarea - attributes: - label: Additional information - description: If your problem needs further explanation, please add more information here diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml deleted file mode 100644 index e10512398..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ /dev/null @@ -1,46 +0,0 @@ -name: Feature Request -description: Suggest an idea for Ferdium -title: "Feature: " -labels: ["enhancement :sparkles:"] -body: - - type: markdown - 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 Ferdium, please log it [here](https://github.com/ferdium/ferdium-recipes/pulls) - 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. If you are adding screenshots and/or videos, please do add it in English so that a wider group of people can understand and help with resolution. - 5. Please fill our form below, this way we can analyse and fix the problem as fast as possible. - - type: checkboxes - attributes: - label: Preflight Checklist - description: Please ensure you've completed all of the following. - options: - - label: I have read the [Contributing Guidelines](https://github.com/ferdium/ferdium-app/blob/develop/CONTRIBUTING.md) for this project. - required: true - - label: I agree to follow the [Code of Conduct](https://github.com/ferdium/ferdium-app/blob/develop/CODE_OF_CONDUCT.md) that this project adheres to. - required: true - - label: I have searched the [issue tracker](https://github.com/ferdium/ferdium-app/issues) for a feature request that matches the one I want to file, without success. - required: true - - type: textarea - attributes: - label: Problem Description - description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - validations: - required: true - - type: textarea - attributes: - label: Proposed Solution - description: A clear and concise description of what you want to happen. - validations: - required: true - - type: textarea - attributes: - label: Alternatives Considered - description: A clear and concise description of any alternative solutions or features you've considered. - validations: - required: true - - type: textarea - attributes: - label: Additional Information - description: Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/recipe_bug_report.yml b/.github/ISSUE_TEMPLATE/recipe_bug_report.yml new file mode 100644 index 000000000..8bfc312b3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/recipe_bug_report.yml @@ -0,0 +1,80 @@ +name: Bug Report +description: Report an Ferdium bug +title: "[Bug]: " +labels: ["bug :beetle:"] +body: +- type: markdown + 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 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 + attributes: + label: Preflight Checklist + description: Please ensure you've completed all of the following. + options: + - label: I have read the [Contributing Guidelines](https://github.com/ferdium/ferdium-app/blob/develop/CONTRIBUTING.md) for this project. + required: true + - label: I agree to follow the [Code of Conduct](https://github.com/ferdium/ferdium-recipes/blob/main/CODE_OF_CONDUCT.md) that this project adheres to. + required: true + - label: I have searched the [issue tracker](https://github.com/ferdium/ferdium-recipes/issues) for a feature request that matches the one I want to file, without success. + required: true +- type: input + attributes: + label: Ferdium Version + description: What version of Ferdium are you using? + placeholder: 5.6.3 + validations: + required: true +- type: input + attributes: + label: Recipe Name + description: What is the name of the specific recipe you are using? + placeholder: 1.0.0 + validations: + required: true +- type: input + attributes: + label: Recipe Version + description: What version of the specific recipe are you using? + placeholder: 1.0.0 + validations: + required: true +- type: input + attributes: + label: Last Known working version of the recipe + description: What is the last version of the recipe this worked in, if applicable? + placeholder: 1.0.0 +- type: textarea + attributes: + label: Steps to reproduce + description: Explain to us how we can reproduce your bug on our computer + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: true +- type: textarea + attributes: + label: Expected Behavior + description: A clear and concise description of what you expected to happen. + validations: + required: true +- type: textarea + attributes: + label: Actual Behavior + description: A clear description of what actually happens. + validations: + required: true +- type: textarea + attributes: + label: Screenshots + description: If applicable, add screenshots to help explain your problem. You can simply drag and drop any image file into the editor to add it to the report +- type: textarea + attributes: + label: Additional Information + description: If your problem needs further explanation, or if the issue you're seeing cannot be reproduced in a gist, please add more information here. diff --git a/.github/ISSUE_TEMPLATE/recipe_request.yml b/.github/ISSUE_TEMPLATE/recipe_request.yml new file mode 100644 index 000000000..517d4fffd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/recipe_request.yml @@ -0,0 +1,56 @@ +name: New Service-recipe Request +description: Suggest a service that we should add to Ferdium +title: "[Recipe Request]: " +labels: ["recipe request :sparkles:"] +body: +- type: markdown + attributes: + value: | + 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 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. + + 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 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 + attributes: + label: Preflight Checklist + description: Please ensure you've completed all of the following. + options: + - label: I have read the [Contributing Guidelines](https://github.com/ferdium/ferdium-recipes/blob/develop/CONTRIBUTING.md) for this project. + required: true + - label: I agree to follow the [Code of Conduct](https://github.com/ferdium/ferdium-recipes/blob/develop/CODE_OF_CONDUCT.md) that this project adheres to. + required: true + - label: I have searched the [issue tracker](https://github.com/ferdium/ferdium-recipes/issues) for a feature request that matches the one I want to file, without success. + required: true +- type: input + attributes: + label: Name of the service + description: What is the name of the service you are requesting? + placeholder: WhatsApp + validations: + required: true +- type: input + attributes: + label: URL of the service + description: What is the URL of the service you are requesting? + placeholder: https://web.whatsapp.com +- type: input + attributes: + label: GitHub URL to a recipe that has already been created by someone else or you + description: What is the URL of the service-recipe? + placeholder: https://github.com/... +- type: textarea + attributes: + label: Features you want implemented + description: A clear and concise description of what features you want implemented eg Notification support + validations: + required: true -- cgit v1.2.3-70-g09d2 From 823bdbc0d6be46e4745ae10feb108fff55742fb9 Mon Sep 17 00:00:00 2001 From: Nathanaël Houn Date: Wed, 15 Feb 2023 20:37:29 +0100 Subject: docs: improve clarity --- .github/ISSUE_TEMPLATE/app_bug_report.yml | 14 ++++++-------- .github/ISSUE_TEMPLATE/app_feature_request.yml | 17 ++++++++--------- .github/ISSUE_TEMPLATE/open_issue.yml | 6 +++--- .github/ISSUE_TEMPLATE/recipe_bug_report.yml | 6 +++--- .github/ISSUE_TEMPLATE/recipe_request.yml | 17 +++++++---------- 5 files changed, 27 insertions(+), 33 deletions(-) (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE/app_bug_report.yml b/.github/ISSUE_TEMPLATE/app_bug_report.yml index a253adca4..1dd687e52 100644 --- a/.github/ISSUE_TEMPLATE/app_bug_report.yml +++ b/.github/ISSUE_TEMPLATE/app_bug_report.yml @@ -1,16 +1,14 @@ -name: App Bug report -description: Report a bug in the Ferdium App -title: "Bug: " +name: App - Bug report +description: Report a bug in the Ferdium app +title: "[Bug]: " labels: ["bug :beetle:"] body: - type: markdown 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 Ferdium, please log it [here](https://github.com/ferdium/ferdium-recipes/pulls) - 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. If you are adding screenshots and/or videos, please do add it in English so that a wider group of people can understand and help with resolution. - 5. Please fill our form below, this way we can analyse and fix the problem as fast as possible. + 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. + 2. If you are adding screenshots and/or videos, please do add it in English so that a wider group of people can understand and help with resolution. + 3. Please fill our form below, this way we can analyse and fix the problem as fast as possible. - type: checkboxes attributes: label: Avoid duplicates diff --git a/.github/ISSUE_TEMPLATE/app_feature_request.yml b/.github/ISSUE_TEMPLATE/app_feature_request.yml index e10512398..10a73a8d5 100644 --- a/.github/ISSUE_TEMPLATE/app_feature_request.yml +++ b/.github/ISSUE_TEMPLATE/app_feature_request.yml @@ -1,16 +1,14 @@ -name: Feature Request -description: Suggest an idea for Ferdium -title: "Feature: " +name: App - Feature Request +description: Suggest an idea for the Ferdium app +title: "[Feature]: " labels: ["enhancement :sparkles:"] body: - type: markdown 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 Ferdium, please log it [here](https://github.com/ferdium/ferdium-recipes/pulls) - 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. If you are adding screenshots and/or videos, please do add it in English so that a wider group of people can understand and help with resolution. - 5. Please fill our form below, this way we can analyse and fix the problem as fast as possible. + 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. + 2. If you are adding screenshots and/or videos, please do add it in English so that a wider group of people can understand and help with resolution. + 3. Please fill our form below, this way we can analyse and fix the problem as fast as possible. - type: checkboxes attributes: label: Preflight Checklist @@ -25,7 +23,8 @@ body: - type: textarea attributes: label: Problem Description - description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + description: A clear and concise description of what the problem is. + placeholder: Ex. I'm always frustrated when [...] validations: required: true - type: textarea diff --git a/.github/ISSUE_TEMPLATE/open_issue.yml b/.github/ISSUE_TEMPLATE/open_issue.yml index fd643cafb..4c8296f90 100644 --- a/.github/ISSUE_TEMPLATE/open_issue.yml +++ b/.github/ISSUE_TEMPLATE/open_issue.yml @@ -1,11 +1,11 @@ -name: Open empty issue +name: Something else? Open empty issue description: For everything that's neither a feature request, nor a bug body: - type: markdown 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/fedium-recipes/issues) - 2. If you are requesting support for a new service in Ferdium, please log it [here](https://github.com/ferdium/ferdium-recipes/pulls) + 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-app/issues) by selecting the related issue category + 2. If you are requesting support for a new service in Ferdium, please log it [here](https://github.com/ferdium/ferdium-app/issues) by selecting the related issue category 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. If you are adding screenshots and/or videos, please do add it in English so that a wider group of people can understand and help with resolution. - type: textarea diff --git a/.github/ISSUE_TEMPLATE/recipe_bug_report.yml b/.github/ISSUE_TEMPLATE/recipe_bug_report.yml index 8bfc312b3..969ec96c9 100644 --- a/.github/ISSUE_TEMPLATE/recipe_bug_report.yml +++ b/.github/ISSUE_TEMPLATE/recipe_bug_report.yml @@ -1,7 +1,7 @@ -name: Bug Report -description: Report an Ferdium bug +name: Recipes - Bug Report +description: Report a bug in a Ferdium Recipe for a particular service title: "[Bug]: " -labels: ["bug :beetle:"] +labels: ["bug :beetle:", "recipe :bookmark_tabs:"] body: - type: markdown attributes: diff --git a/.github/ISSUE_TEMPLATE/recipe_request.yml b/.github/ISSUE_TEMPLATE/recipe_request.yml index 517d4fffd..895464e03 100644 --- a/.github/ISSUE_TEMPLATE/recipe_request.yml +++ b/.github/ISSUE_TEMPLATE/recipe_request.yml @@ -1,7 +1,7 @@ -name: New Service-recipe Request -description: Suggest a service that we should add to Ferdium +name: Recipes - New Service Request +description: Suggest a service that we should add to Ferdium Recipes title: "[Recipe Request]: " -labels: ["recipe request :sparkles:"] +labels: ["recipe request :sparkles:", "recipe :bookmark_tabs:"] body: - type: markdown attributes: @@ -16,20 +16,17 @@ 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 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. + 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. - type: checkboxes attributes: label: Preflight Checklist description: Please ensure you've completed all of the following. options: - - label: I have read the [Contributing Guidelines](https://github.com/ferdium/ferdium-recipes/blob/develop/CONTRIBUTING.md) for this project. + - label: I have read the [Contributing Guidelines](https://github.com/ferdium/ferdium-recipes/blob/develop/CONTRIBUTING.md) for Ferdium Recipes. required: true - - label: I agree to follow the [Code of Conduct](https://github.com/ferdium/ferdium-recipes/blob/develop/CODE_OF_CONDUCT.md) that this project adheres to. + - 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. required: true - - label: I have searched the [issue tracker](https://github.com/ferdium/ferdium-recipes/issues) for a feature request that matches the one I want to file, without success. + - 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. required: true - type: input attributes: -- cgit v1.2.3-70-g09d2 From 219318a087a9cd55788d1c8657f09e587ffcdc40 Mon Sep 17 00:00:00 2001 From: Nathanaël Houn Date: Wed, 15 Feb 2023 19:42:35 +0100 Subject: docs: remove title because we have tags --- .github/ISSUE_TEMPLATE/app_bug_report.yml | 1 - .github/ISSUE_TEMPLATE/app_feature_request.yml | 1 - .github/ISSUE_TEMPLATE/recipe_bug_report.yml | 1 - .github/ISSUE_TEMPLATE/recipe_request.yml | 1 - 4 files changed, 4 deletions(-) (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE/app_bug_report.yml b/.github/ISSUE_TEMPLATE/app_bug_report.yml index 1dd687e52..022266e65 100644 --- a/.github/ISSUE_TEMPLATE/app_bug_report.yml +++ b/.github/ISSUE_TEMPLATE/app_bug_report.yml @@ -1,6 +1,5 @@ name: App - Bug report description: Report a bug in the Ferdium app -title: "[Bug]: " labels: ["bug :beetle:"] body: - type: markdown diff --git a/.github/ISSUE_TEMPLATE/app_feature_request.yml b/.github/ISSUE_TEMPLATE/app_feature_request.yml index 10a73a8d5..f96d88d0a 100644 --- a/.github/ISSUE_TEMPLATE/app_feature_request.yml +++ b/.github/ISSUE_TEMPLATE/app_feature_request.yml @@ -1,6 +1,5 @@ name: App - Feature Request description: Suggest an idea for the Ferdium app -title: "[Feature]: " labels: ["enhancement :sparkles:"] body: - type: markdown diff --git a/.github/ISSUE_TEMPLATE/recipe_bug_report.yml b/.github/ISSUE_TEMPLATE/recipe_bug_report.yml index 969ec96c9..8e71af482 100644 --- a/.github/ISSUE_TEMPLATE/recipe_bug_report.yml +++ b/.github/ISSUE_TEMPLATE/recipe_bug_report.yml @@ -1,6 +1,5 @@ name: Recipes - Bug Report description: Report a bug in a Ferdium Recipe for a particular service -title: "[Bug]: " labels: ["bug :beetle:", "recipe :bookmark_tabs:"] body: - type: markdown diff --git a/.github/ISSUE_TEMPLATE/recipe_request.yml b/.github/ISSUE_TEMPLATE/recipe_request.yml index 895464e03..9380fff29 100644 --- a/.github/ISSUE_TEMPLATE/recipe_request.yml +++ b/.github/ISSUE_TEMPLATE/recipe_request.yml @@ -1,6 +1,5 @@ name: Recipes - New Service Request description: Suggest a service that we should add to Ferdium Recipes -title: "[Recipe Request]: " labels: ["recipe request :sparkles:", "recipe :bookmark_tabs:"] body: - type: markdown -- cgit v1.2.3-70-g09d2 From bfec21c23d1f2bb6dd6c9b19e00f6f17c47d19bf Mon Sep 17 00:00:00 2001 From: Nathanaël Houn Date: Wed, 15 Feb 2023 19:43:08 +0100 Subject: docs: reorder issues templates --- .github/ISSUE_TEMPLATE/open_issue.yml | 16 ---------------- .github/ISSUE_TEMPLATE/something_else_open_issue.yml | 16 ++++++++++++++++ 2 files changed, 16 insertions(+), 16 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/open_issue.yml create mode 100644 .github/ISSUE_TEMPLATE/something_else_open_issue.yml (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE/open_issue.yml b/.github/ISSUE_TEMPLATE/open_issue.yml deleted file mode 100644 index 4c8296f90..000000000 --- a/.github/ISSUE_TEMPLATE/open_issue.yml +++ /dev/null @@ -1,16 +0,0 @@ -name: Something else? Open empty issue -description: For everything that's neither a feature request, nor a bug -body: - - type: markdown - 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-app/issues) by selecting the related issue category - 2. If you are requesting support for a new service in Ferdium, please log it [here](https://github.com/ferdium/ferdium-app/issues) by selecting the related issue category - 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. If you are adding screenshots and/or videos, please do add it in English so that a wider group of people can understand and help with resolution. - - type: textarea - attributes: - label: "Your issue" - description: "Describe your issue" - validations: - required: true diff --git a/.github/ISSUE_TEMPLATE/something_else_open_issue.yml b/.github/ISSUE_TEMPLATE/something_else_open_issue.yml new file mode 100644 index 000000000..4c8296f90 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/something_else_open_issue.yml @@ -0,0 +1,16 @@ +name: Something else? Open empty issue +description: For everything that's neither a feature request, nor a bug +body: + - type: markdown + 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-app/issues) by selecting the related issue category + 2. If you are requesting support for a new service in Ferdium, please log it [here](https://github.com/ferdium/ferdium-app/issues) by selecting the related issue category + 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. If you are adding screenshots and/or videos, please do add it in English so that a wider group of people can understand and help with resolution. + - type: textarea + attributes: + label: "Your issue" + description: "Describe your issue" + validations: + required: true -- cgit v1.2.3-70-g09d2 From 362282fe801c9994eae4b6518550beca9c806d0b Mon Sep 17 00:00:00 2001 From: Nathanaël Houn Date: Wed, 15 Feb 2023 20:05:34 +0100 Subject: docs: fix dead links --- .github/ISSUE_TEMPLATE/app_bug_report.yml | 7 ++++--- .github/ISSUE_TEMPLATE/app_feature_request.yml | 9 ++++----- .github/ISSUE_TEMPLATE/recipe_bug_report.yml | 14 +++++--------- .github/ISSUE_TEMPLATE/recipe_request.yml | 16 ++++++---------- .github/ISSUE_TEMPLATE/something_else_open_issue.yml | 3 +-- 5 files changed, 20 insertions(+), 29 deletions(-) (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE/app_bug_report.yml b/.github/ISSUE_TEMPLATE/app_bug_report.yml index 022266e65..5e4afeacd 100644 --- a/.github/ISSUE_TEMPLATE/app_bug_report.yml +++ b/.github/ISSUE_TEMPLATE/app_bug_report.yml @@ -5,15 +5,16 @@ body: - type: markdown attributes: value: | - 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. + 1. Please fill our form below, this way we can analyse and fix the problem as fast as possible. 2. If you are adding screenshots and/or videos, please do add it in English so that a wider group of people can understand and help with resolution. - 3. Please fill our form below, this way we can analyse and fix the problem as fast as possible. - type: checkboxes attributes: label: Avoid duplicates description: Please ensure you've completed the following options: - - label: I have searched the [issues tracker](https://github.com/ferdium/ferdium-app/issues) for a bug report similar to mine, in vain + - label: I agree to follow the [Code of Conduct](https://github.com/ferdium/ferdium-app/blob/HEAD/CODE_OF_CONDUCT.md) that this project adheres to. + required: true + - label: I have searched the [issues tracker](https://github.com/ferdium/ferdium-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22bug+%3Abeetle%3A%22) for a bug report similar to mine, in vain required: true - type: input attributes: diff --git a/.github/ISSUE_TEMPLATE/app_feature_request.yml b/.github/ISSUE_TEMPLATE/app_feature_request.yml index f96d88d0a..0b7706ace 100644 --- a/.github/ISSUE_TEMPLATE/app_feature_request.yml +++ b/.github/ISSUE_TEMPLATE/app_feature_request.yml @@ -5,19 +5,18 @@ body: - type: markdown attributes: value: | - 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. + 1. Please fill our form below, this way we can analyse and fix the problem as fast as possible. 2. If you are adding screenshots and/or videos, please do add it in English so that a wider group of people can understand and help with resolution. - 3. Please fill our form below, this way we can analyse and fix the problem as fast as possible. - type: checkboxes attributes: label: Preflight Checklist description: Please ensure you've completed all of the following. options: - - label: I have read the [Contributing Guidelines](https://github.com/ferdium/ferdium-app/blob/develop/CONTRIBUTING.md) for this project. + - label: I have read the [Contributing Guidelines](https://github.com/ferdium/ferdium-app/blob/HEAD/CONTRIBUTING.md) for this project. required: true - - label: I agree to follow the [Code of Conduct](https://github.com/ferdium/ferdium-app/blob/develop/CODE_OF_CONDUCT.md) that this project adheres to. + - label: I agree to follow the [Code of Conduct](https://github.com/ferdium/ferdium-app/blob/HEAD/CODE_OF_CONDUCT.md) that this project adheres to. required: true - - label: I have searched the [issue tracker](https://github.com/ferdium/ferdium-app/issues) for a feature request that matches the one I want to file, without success. + - label: I have searched the [issue tracker](https://github.com/ferdium/ferdium-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22enhancement+%3Asparkles%3A%22) for a feature request that matches the one I want to file, without success. required: true - type: textarea attributes: diff --git a/.github/ISSUE_TEMPLATE/recipe_bug_report.yml b/.github/ISSUE_TEMPLATE/recipe_bug_report.yml index 8e71af482..c02382866 100644 --- a/.github/ISSUE_TEMPLATE/recipe_bug_report.yml +++ b/.github/ISSUE_TEMPLATE/recipe_bug_report.yml @@ -5,20 +5,16 @@ body: - type: markdown 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 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. + 1. Please fill our form below, this way we can analyse and fix the problem as fast as possible. + 2. If you are adding screenshots and/or videos, please do add it in English so that a wider group of people can understand and help with resolution. - type: checkboxes attributes: label: Preflight Checklist description: Please ensure you've completed all of the following. options: - - label: I have read the [Contributing Guidelines](https://github.com/ferdium/ferdium-app/blob/develop/CONTRIBUTING.md) for this project. + - 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. required: true - - label: I agree to follow the [Code of Conduct](https://github.com/ferdium/ferdium-recipes/blob/main/CODE_OF_CONDUCT.md) that this project adheres to. - required: true - - label: I have searched the [issue tracker](https://github.com/ferdium/ferdium-recipes/issues) for a feature request that matches the one I want to file, without success. + - label: I have searched the [issue tracker](https://github.com/ferdium/ferdium-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22recipe+%3Abookmark_tabs%3A%22+label%3A%22bug+%3Abeetle%3A%22+) for a bug report that matches the one I want to file, without success. required: true - type: input attributes: @@ -31,7 +27,7 @@ body: attributes: label: Recipe Name description: What is the name of the specific recipe you are using? - placeholder: 1.0.0 + placeholder: WhatsApp validations: required: true - type: input 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: - type: markdown attributes: value: | - Before creating a new recipe request please check if you can add it yourself. + 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 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. + 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"). + 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. - 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. + 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). 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 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. - type: checkboxes attributes: label: Preflight Checklist description: Please ensure you've completed all of the following. options: - - label: I have read the [Contributing Guidelines](https://github.com/ferdium/ferdium-recipes/blob/develop/CONTRIBUTING.md) for Ferdium Recipes. - required: true - - 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. + - 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. required: true - - 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. + - 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. required: true - type: input attributes: diff --git a/.github/ISSUE_TEMPLATE/something_else_open_issue.yml b/.github/ISSUE_TEMPLATE/something_else_open_issue.yml index 4c8296f90..4951f41cc 100644 --- a/.github/ISSUE_TEMPLATE/something_else_open_issue.yml +++ b/.github/ISSUE_TEMPLATE/something_else_open_issue.yml @@ -6,8 +6,7 @@ body: 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-app/issues) by selecting the related issue category 2. If you are requesting support for a new service in Ferdium, please log it [here](https://github.com/ferdium/ferdium-app/issues) by selecting the related issue category - 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. If you are adding screenshots and/or videos, please do add it in English so that a wider group of people can understand and help with resolution. + 3. If you are adding screenshots and/or videos, please do add it in English so that a wider group of people can understand and help with resolution. - type: textarea attributes: label: "Your issue" -- cgit v1.2.3-70-g09d2 From def8011dc39b5f05a81336d257ce65b6338102ce Mon Sep 17 00:00:00 2001 From: Nathanaël Houn Date: Wed, 15 Feb 2023 20:06:10 +0100 Subject: chore: issue templates formatting --- .github/ISSUE_TEMPLATE/recipe_bug_report.yml | 142 +++++++++++++-------------- .github/ISSUE_TEMPLATE/recipe_request.yml | 82 ++++++++-------- 2 files changed, 112 insertions(+), 112 deletions(-) (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE/recipe_bug_report.yml b/.github/ISSUE_TEMPLATE/recipe_bug_report.yml index c02382866..3cf7cfe80 100644 --- a/.github/ISSUE_TEMPLATE/recipe_bug_report.yml +++ b/.github/ISSUE_TEMPLATE/recipe_bug_report.yml @@ -2,74 +2,74 @@ name: Recipes - Bug Report description: Report a bug in a Ferdium Recipe for a particular service labels: ["bug :beetle:", "recipe :bookmark_tabs:"] body: -- type: markdown - attributes: - value: | - 1. Please fill our form below, this way we can analyse and fix the problem as fast as possible. - 2. If you are adding screenshots and/or videos, please do add it in English so that a wider group of people can understand and help with resolution. -- type: checkboxes - attributes: - label: Preflight Checklist - description: Please ensure you've completed all of the following. - options: - - 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. - required: true - - label: I have searched the [issue tracker](https://github.com/ferdium/ferdium-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22recipe+%3Abookmark_tabs%3A%22+label%3A%22bug+%3Abeetle%3A%22+) for a bug report that matches the one I want to file, without success. - required: true -- type: input - attributes: - label: Ferdium Version - description: What version of Ferdium are you using? - placeholder: 5.6.3 - validations: - required: true -- type: input - attributes: - label: Recipe Name - description: What is the name of the specific recipe you are using? - placeholder: WhatsApp - validations: - required: true -- type: input - attributes: - label: Recipe Version - description: What version of the specific recipe are you using? - placeholder: 1.0.0 - validations: - required: true -- type: input - attributes: - label: Last Known working version of the recipe - description: What is the last version of the recipe this worked in, if applicable? - placeholder: 1.0.0 -- type: textarea - attributes: - label: Steps to reproduce - description: Explain to us how we can reproduce your bug on our computer - placeholder: | - 1. Go to '...' - 2. Click on '....' - 3. Scroll down to '....' - 4. See error - validations: - required: true -- type: textarea - attributes: - label: Expected Behavior - description: A clear and concise description of what you expected to happen. - validations: - required: true -- type: textarea - attributes: - label: Actual Behavior - description: A clear description of what actually happens. - validations: - required: true -- type: textarea - attributes: - label: Screenshots - description: If applicable, add screenshots to help explain your problem. You can simply drag and drop any image file into the editor to add it to the report -- type: textarea - attributes: - label: Additional Information - description: If your problem needs further explanation, or if the issue you're seeing cannot be reproduced in a gist, please add more information here. + - type: markdown + attributes: + value: | + 1. Please fill our form below, this way we can analyse and fix the problem as fast as possible. + 2. If you are adding screenshots and/or videos, please do add it in English so that a wider group of people can understand and help with resolution. + - type: checkboxes + attributes: + label: Preflight Checklist + description: Please ensure you've completed all of the following. + options: + - 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. + required: true + - label: I have searched the [issue tracker](https://github.com/ferdium/ferdium-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22recipe+%3Abookmark_tabs%3A%22+label%3A%22bug+%3Abeetle%3A%22+) for a bug report that matches the one I want to file, without success. + required: true + - type: input + attributes: + label: Ferdium Version + description: What version of Ferdium are you using? + placeholder: 5.6.3 + validations: + required: true + - type: input + attributes: + label: Recipe Name + description: What is the name of the specific recipe you are using? + placeholder: WhatsApp + validations: + required: true + - type: input + attributes: + label: Recipe Version + description: What version of the specific recipe are you using? + placeholder: 1.0.0 + validations: + required: true + - type: input + attributes: + label: Last Known working version of the recipe + description: What is the last version of the recipe this worked in, if applicable? + placeholder: 1.0.0 + - type: textarea + attributes: + label: Steps to reproduce + description: Explain to us how we can reproduce your bug on our computer + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: true + - type: textarea + attributes: + label: Expected Behavior + description: A clear and concise description of what you expected to happen. + validations: + required: true + - type: textarea + attributes: + label: Actual Behavior + description: A clear description of what actually happens. + validations: + required: true + - type: textarea + attributes: + label: Screenshots + description: If applicable, add screenshots to help explain your problem. You can simply drag and drop any image file into the editor to add it to the report + - type: textarea + attributes: + label: Additional Information + description: If your problem needs further explanation, or if the issue you're seeing cannot be reproduced in a gist, please add more information here. diff --git a/.github/ISSUE_TEMPLATE/recipe_request.yml b/.github/ISSUE_TEMPLATE/recipe_request.yml index e87a62c63..c84b456f1 100644 --- a/.github/ISSUE_TEMPLATE/recipe_request.yml +++ b/.github/ISSUE_TEMPLATE/recipe_request.yml @@ -2,47 +2,47 @@ name: Recipes - New Service Request description: Suggest a service that we should add to Ferdium Recipes labels: ["recipe request :sparkles:", "recipe :bookmark_tabs:"] body: -- type: markdown - attributes: - value: | - 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. + - type: markdown + attributes: + value: | + 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 "Ferdium" or "Ferdi" on Github (e.g "WhatsApp Ferdium"), optionally you can also add "recipe" to the search query (e.g. "WhatsApp Ferdium 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. + 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"). + 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. - 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). + 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). - IF YOU ARE NOT FAMILIAR WITH JAVASCRIPT: Please still search for a recipe using the guide above and add it to your request. -- type: checkboxes - attributes: - label: Preflight Checklist - description: Please ensure you've completed all of the following. - options: - - 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. - required: true - - 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. - required: true -- type: input - attributes: - label: Name of the service - description: What is the name of the service you are requesting? - placeholder: WhatsApp - validations: - required: true -- type: input - attributes: - label: URL of the service - description: What is the URL of the service you are requesting? - placeholder: https://web.whatsapp.com -- type: input - attributes: - label: GitHub URL to a recipe that has already been created by someone else or you - description: What is the URL of the service-recipe? - placeholder: https://github.com/... -- type: textarea - attributes: - label: Features you want implemented - description: A clear and concise description of what features you want implemented eg Notification support - validations: - required: true + IF YOU ARE NOT FAMILIAR WITH JAVASCRIPT: Please still search for a recipe using the guide above and add it to your request. + - type: checkboxes + attributes: + label: Preflight Checklist + description: Please ensure you've completed all of the following. + options: + - 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. + required: true + - 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. + required: true + - type: input + attributes: + label: Name of the service + description: What is the name of the service you are requesting? + placeholder: WhatsApp + validations: + required: true + - type: input + attributes: + label: URL of the service + description: What is the URL of the service you are requesting? + placeholder: https://web.whatsapp.com + - type: input + attributes: + label: GitHub URL to a recipe that has already been created by someone else or you + description: What is the URL of the service-recipe? + placeholder: https://github.com/... + - type: textarea + attributes: + label: Features you want implemented + description: A clear and concise description of what features you want implemented eg Notification support + validations: + required: true -- cgit v1.2.3-70-g09d2 From fa3b860d72555d5820c7ad4ed1230697d624dd80 Mon Sep 17 00:00:00 2001 From: Nathanaël Houn Date: Wed, 15 Feb 2023 20:08:31 +0100 Subject: docs: wording --- .github/ISSUE_TEMPLATE/something_else_open_issue.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE/something_else_open_issue.yml b/.github/ISSUE_TEMPLATE/something_else_open_issue.yml index 4951f41cc..78a597d9b 100644 --- a/.github/ISSUE_TEMPLATE/something_else_open_issue.yml +++ b/.github/ISSUE_TEMPLATE/something_else_open_issue.yml @@ -1,4 +1,4 @@ -name: Something else? Open empty issue +name: Something else? Open empty an issue description: For everything that's neither a feature request, nor a bug body: - type: markdown -- cgit v1.2.3-70-g09d2 From e8a4ea5e1deb1256289780efbaa746602b92abc2 Mon Sep 17 00:00:00 2001 From: Nathanaël Houn Date: Wed, 15 Feb 2023 20:09:58 +0100 Subject: fix: formatting --- .github/ISSUE_TEMPLATE/recipe_request.yml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE/recipe_request.yml b/.github/ISSUE_TEMPLATE/recipe_request.yml index c84b456f1..0eedb5f0e 100644 --- a/.github/ISSUE_TEMPLATE/recipe_request.yml +++ b/.github/ISSUE_TEMPLATE/recipe_request.yml @@ -5,15 +5,15 @@ body: - type: markdown attributes: value: | - 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. + 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 "Ferdium" or "Ferdi" on Github (e.g "WhatsApp Ferdium"), optionally you can also add "recipe" to the search query (e.g. "WhatsApp Ferdium 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. + 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"). + 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. 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). - IF YOU ARE NOT FAMILIAR WITH JAVASCRIPT: Please still search for a recipe using the guide above and add it to your request. + **If you are not familiar with JavaScript:** Please still search for a recipe using the guide above and add it to your request. - type: checkboxes attributes: label: Preflight Checklist -- cgit v1.2.3-70-g09d2 From a933b8737ef918d4709c63b3c10ad7a02661569e Mon Sep 17 00:00:00 2001 From: Nathanaël Houn Date: Wed, 15 Feb 2023 20:28:04 +0100 Subject: docs: reduce PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) (limited to '.github') diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 44abd46f8..3a9eb4477 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -5,14 +5,10 @@ #### Pre-flight Checklist -1. Please remember that if you are logging a bug for some service that has _stopped working_ or is _working incorrectly_, please log the bug [here](https://github.com/ferdium/ferdium-recipes/issues) -2. If you are requesting support for a **new service** in Ferdium, please log it [here](https://github.com/ferdium/ferdium-recipes/pulls) -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 older versions of recipes that were installed on your machine. (These will get automatically upgraded when you upgrade to the newer versions of Ferdium, but to get new recipes between Ferdium releases, this documentation is quite useful.) -4. Please ensure you've completed all of the following. - -- [ ] I have read the [Contributing Guidelines](https://github.com/ferdium/ferdium-app/blob/develop/CONTRIBUTING.md) for this project. -- [ ] I agree to follow the [Code of Conduct](https://github.com/ferdium/ferdium-app/blob/develop/CODE_OF_CONDUCT.md) that this project adheres to. -- [ ] I have searched the [issue tracker](https://github.com/ferdium/ferdium-app/issues) for a feature request that matches the one I want to file, without success. +Please ensure you've completed all of the following. + +- [ ] I have read the [Contributing Guidelines](https://github.com/ferdium/ferdium-app/blob/HEAD/CONTRIBUTING.md) for this project. +- [ ] I agree to follow the [Code of Conduct](https://github.com/ferdium/ferdium-app/blob/HEAD/CODE_OF_CONDUCT.md) that this project adheres to. #### Description of Change -- cgit v1.2.3-70-g09d2 From 7fba92a957351e8f00d1ee04e01f46b0822605fa Mon Sep 17 00:00:00 2001 From: Nathanaël Houn Date: Thu, 16 Feb 2023 00:28:03 +0100 Subject: docs: apply wording --- .github/ISSUE_TEMPLATE/something_else_open_issue.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE/something_else_open_issue.yml b/.github/ISSUE_TEMPLATE/something_else_open_issue.yml index 78a597d9b..dc4952ca6 100644 --- a/.github/ISSUE_TEMPLATE/something_else_open_issue.yml +++ b/.github/ISSUE_TEMPLATE/something_else_open_issue.yml @@ -1,4 +1,4 @@ -name: Something else? Open empty an issue +name: Open empty an issue description: For everything that's neither a feature request, nor a bug body: - type: markdown -- cgit v1.2.3-70-g09d2 From 31e842bf3ce7016d063f042d00664a736ab3e174 Mon Sep 17 00:00:00 2001 From: Vijay Aravamudhan Date: Thu, 16 Feb 2023 01:17:49 +0000 Subject: fixed grammatical mistake --- .github/ISSUE_TEMPLATE/something_else_open_issue.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE/something_else_open_issue.yml b/.github/ISSUE_TEMPLATE/something_else_open_issue.yml index dc4952ca6..41e6f9187 100644 --- a/.github/ISSUE_TEMPLATE/something_else_open_issue.yml +++ b/.github/ISSUE_TEMPLATE/something_else_open_issue.yml @@ -1,4 +1,4 @@ -name: Open empty an issue +name: Open an empty issue description: For everything that's neither a feature request, nor a bug body: - type: markdown -- cgit v1.2.3-70-g09d2 From 9a861a945cc5cd08bf4620173c3270f0cf801166 Mon Sep 17 00:00:00 2001 From: Vijay Aravamudhan Date: Thu, 16 Feb 2023 01:59:25 +0000 Subject: Refer to CODE_OF_CONDUCT from app repo --- .github/ISSUE_TEMPLATE/recipe_bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE/recipe_bug_report.yml b/.github/ISSUE_TEMPLATE/recipe_bug_report.yml index 3cf7cfe80..79c2600ec 100644 --- a/.github/ISSUE_TEMPLATE/recipe_bug_report.yml +++ b/.github/ISSUE_TEMPLATE/recipe_bug_report.yml @@ -12,7 +12,7 @@ body: label: Preflight Checklist description: Please ensure you've completed all of the following. options: - - 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. + - label: I agree to follow the [Code of Conduct](https://github.com/ferdium/ferdium-app/blob/HEAD/CODE_OF_CONDUCT.md) that Ferdium Recipes adheres to. required: true - label: I have searched the [issue tracker](https://github.com/ferdium/ferdium-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22recipe+%3Abookmark_tabs%3A%22+label%3A%22bug+%3Abeetle%3A%22+) for a bug report that matches the one I want to file, without success. required: true -- cgit v1.2.3-70-g09d2 From b6bfeaef4117b253d53e20f140c65078ad1ad194 Mon Sep 17 00:00:00 2001 From: Vijay Aravamudhan Date: Thu, 16 Feb 2023 02:00:22 +0000 Subject: Refer to CODE_OF_CONDUCT from app repo --- .github/ISSUE_TEMPLATE/recipe_request.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE/recipe_request.yml b/.github/ISSUE_TEMPLATE/recipe_request.yml index 0eedb5f0e..456c116bb 100644 --- a/.github/ISSUE_TEMPLATE/recipe_request.yml +++ b/.github/ISSUE_TEMPLATE/recipe_request.yml @@ -19,7 +19,7 @@ body: label: Preflight Checklist description: Please ensure you've completed all of the following. options: - - 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. + - label: I agree to follow the [Code of Conduct](https://github.com/ferdium/ferdium-app/blob/HEAD/CODE_OF_CONDUCT.md) that Ferdium Recipes adheres to. required: true - 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. required: true -- cgit v1.2.3-70-g09d2