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