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/ISSUE_TEMPLATE') 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