diff options
author | Nathanaƫl Houn <contact@nathanaelhoun.fr> | 2023-02-15 20:37:29 +0100 |
---|---|---|
committer | Vijay Aravamudhan <vraravam@users.noreply.github.com> | 2023-02-16 09:40:30 +0530 |
commit | 823bdbc0d6be46e4745ae10feb108fff55742fb9 (patch) | |
tree | 2f89a1ab645de2b8e5fba1f01db9056e283bb47b /.github | |
parent | docs: add issues templates from recipes (diff) | |
download | ferdium-app-823bdbc0d6be46e4745ae10feb108fff55742fb9.tar.gz ferdium-app-823bdbc0d6be46e4745ae10feb108fff55742fb9.tar.zst ferdium-app-823bdbc0d6be46e4745ae10feb108fff55742fb9.zip |
docs: improve clarity
Diffstat (limited to '.github')
-rw-r--r-- | .github/ISSUE_TEMPLATE/app_bug_report.yml | 14 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/app_feature_request.yml | 17 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/open_issue.yml | 6 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/recipe_bug_report.yml | 6 | ||||
-rw-r--r-- | .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 @@ | |||
1 | name: App Bug report | 1 | name: App - Bug report |
2 | description: Report a bug in the Ferdium App | 2 | description: Report a bug in the Ferdium app |
3 | title: "Bug: " | 3 | title: "[Bug]: " |
4 | labels: ["bug :beetle:"] | 4 | labels: ["bug :beetle:"] |
5 | body: | 5 | body: |
6 | - type: markdown | 6 | - type: markdown |
7 | attributes: | 7 | attributes: |
8 | value: | | 8 | value: | |
9 | 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) | 9 | 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. |
10 | 2. If you are requesting support for a new service in Ferdium, please log it [here](https://github.com/ferdium/ferdium-recipes/pulls) | 10 | 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. |
11 | 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. | 11 | 3. Please fill our form below, this way we can analyse and fix the problem as fast as possible. |
12 | 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. | ||
13 | 5. Please fill our form below, this way we can analyse and fix the problem as fast as possible. | ||
14 | - type: checkboxes | 12 | - type: checkboxes |
15 | attributes: | 13 | attributes: |
16 | label: Avoid duplicates | 14 | 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 @@ | |||
1 | name: Feature Request | 1 | name: App - Feature Request |
2 | description: Suggest an idea for Ferdium | 2 | description: Suggest an idea for the Ferdium app |
3 | title: "Feature: " | 3 | title: "[Feature]: " |
4 | labels: ["enhancement :sparkles:"] | 4 | labels: ["enhancement :sparkles:"] |
5 | body: | 5 | body: |
6 | - type: markdown | 6 | - type: markdown |
7 | attributes: | 7 | attributes: |
8 | value: | | 8 | value: | |
9 | 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) | 9 | 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. |
10 | 2. If you are requesting support for a new service in Ferdium, please log it [here](https://github.com/ferdium/ferdium-recipes/pulls) | 10 | 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. |
11 | 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. | 11 | 3. Please fill our form below, this way we can analyse and fix the problem as fast as possible. |
12 | 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. | ||
13 | 5. Please fill our form below, this way we can analyse and fix the problem as fast as possible. | ||
14 | - type: checkboxes | 12 | - type: checkboxes |
15 | attributes: | 13 | attributes: |
16 | label: Preflight Checklist | 14 | label: Preflight Checklist |
@@ -25,7 +23,8 @@ body: | |||
25 | - type: textarea | 23 | - type: textarea |
26 | attributes: | 24 | attributes: |
27 | label: Problem Description | 25 | label: Problem Description |
28 | description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | 26 | description: A clear and concise description of what the problem is. |
27 | placeholder: Ex. I'm always frustrated when [...] | ||
29 | validations: | 28 | validations: |
30 | required: true | 29 | required: true |
31 | - type: textarea | 30 | - 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 @@ | |||
1 | name: Open empty issue | 1 | name: Something else? Open empty issue |
2 | description: For everything that's neither a feature request, nor a bug | 2 | description: For everything that's neither a feature request, nor a bug |
3 | body: | 3 | body: |
4 | - type: markdown | 4 | - type: markdown |
5 | attributes: | 5 | attributes: |
6 | value: | | 6 | value: | |
7 | 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) | 7 | 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 |
8 | 2. If you are requesting support for a new service in Ferdium, please log it [here](https://github.com/ferdium/ferdium-recipes/pulls) | 8 | 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 |
9 | 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. | 9 | 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. |
10 | 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. | 10 | 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. |
11 | - type: textarea | 11 | - 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 @@ | |||
1 | name: Bug Report | 1 | name: Recipes - Bug Report |
2 | description: Report an Ferdium bug | 2 | description: Report a bug in a Ferdium Recipe for a particular service |
3 | title: "[Bug]: " | 3 | title: "[Bug]: " |
4 | labels: ["bug :beetle:"] | 4 | labels: ["bug :beetle:", "recipe :bookmark_tabs:"] |
5 | body: | 5 | body: |
6 | - type: markdown | 6 | - type: markdown |
7 | attributes: | 7 | 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 @@ | |||
1 | name: New Service-recipe Request | 1 | name: Recipes - New Service Request |
2 | description: Suggest a service that we should add to Ferdium | 2 | description: Suggest a service that we should add to Ferdium Recipes |
3 | title: "[Recipe Request]: " | 3 | title: "[Recipe Request]: " |
4 | labels: ["recipe request :sparkles:"] | 4 | labels: ["recipe request :sparkles:", "recipe :bookmark_tabs:"] |
5 | body: | 5 | body: |
6 | - type: markdown | 6 | - type: markdown |
7 | attributes: | 7 | attributes: |
@@ -16,20 +16,17 @@ body: | |||
16 | 16 | ||
17 | IF YOU ARE NOT FAMILIAR WITH JAVASCRIPT: Please still search for a recipe using the guide above and add it to your request. | 17 | IF YOU ARE NOT FAMILIAR WITH JAVASCRIPT: Please still search for a recipe using the guide above and add it to your request. |
18 | 18 | ||
19 | 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) | 19 | 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. |
20 | 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) | ||
21 | 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. | ||
22 | 4. Please fill our form below, this way we can analyse and fix the problem as fast as possible. | ||
23 | - type: checkboxes | 20 | - type: checkboxes |
24 | attributes: | 21 | attributes: |
25 | label: Preflight Checklist | 22 | label: Preflight Checklist |
26 | description: Please ensure you've completed all of the following. | 23 | description: Please ensure you've completed all of the following. |
27 | options: | 24 | options: |
28 | - label: I have read the [Contributing Guidelines](https://github.com/ferdium/ferdium-recipes/blob/develop/CONTRIBUTING.md) for this project. | 25 | - label: I have read the [Contributing Guidelines](https://github.com/ferdium/ferdium-recipes/blob/develop/CONTRIBUTING.md) for Ferdium Recipes. |
29 | required: true | 26 | required: true |
30 | - 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. | 27 | - 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. |
31 | required: true | 28 | required: true |
32 | - 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. | 29 | - 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. |
33 | required: true | 30 | required: true |
34 | - type: input | 31 | - type: input |
35 | attributes: | 32 | attributes: |