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 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-54-g00ecf