diff options
author | NathanaΓ«l Houn <contact@nathanaelhoun.fr> | 2022-04-21 23:15:15 +0200 |
---|---|---|
committer | Vijay Aravamudhan <vraravam@users.noreply.github.com> | 2022-04-21 18:49:29 -0500 |
commit | c261c96a2c9144848a4146428bd39b92850f76e8 (patch) | |
tree | 018da4956d179e98a60b76e81a6fbf465abeb4c6 /.github | |
parent | Branding: Changed the tray and top icons (diff) | |
download | ferdium-app-c261c96a2c9144848a4146428bd39b92850f76e8.tar.gz ferdium-app-c261c96a2c9144848a4146428bd39b92850f76e8.tar.zst ferdium-app-c261c96a2c9144848a4146428bd39b92850f76e8.zip |
docs: fixed and unified issues templates
Diffstat (limited to '.github')
-rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.yml | 76 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/config.yml | 2 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.yml | 88 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/open_issue.yml | 28 |
4 files changed, 105 insertions, 89 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 7b377c331..805398cd1 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml | |||
@@ -1,37 +1,47 @@ | |||
1 | name: Bug report | 1 | name: Bug report |
2 | description: Report a bug in Ferdium | 2 | description: Report a bug in Ferdium |
3 | title: "Describe your bug" | 3 | title: "Bug: " |
4 | labels: ["bug :beetle:"] | 4 | labels: ["bug :beetle:"] |
5 | body: | 5 | body: |
6 | - type: checkboxes | 6 | - type: markdown |
7 | attributes: | 7 | attributes: |
8 | label: Avoid duplicates | 8 | value: | |
9 | description: Please ensure you've completed the following | 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) |
10 | options: | 10 | 2. If you are requesting support for a new service in Ferdium, please log it [here](https://github.com/ferdium/ferdium-recipes/pulls) |
11 | - label: I have searched the [issues tracker](https://github.com/ferdium/ferdium-app/issues) for a bug report similar to mine, in vain | 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. |
12 | required: true | 12 | 4. Please fill our form below, this way we can analyse and fix the problem as fast as possible. |
13 | - type: textarea | 13 | 5. Please consider supporting Ferdium! |
14 | attributes: | 14 | π https://github.com/sponsors/ferdium |
15 | label: Steps to reproduce | 15 | π https://opencollective.com/ferdium/donate |
16 | description: Explain to us how we can reproduce your bug on our computer | 16 | - type: checkboxes |
17 | placeholder: | | 17 | attributes: |
18 | 1. Go to '...' | 18 | label: Avoid duplicates |
19 | 2. Click on '....' | 19 | description: Please ensure you've completed the following |
20 | 3. Scroll down to '....' | 20 | options: |
21 | 4. See error | 21 | - label: I have searched the [issues tracker](https://github.com/ferdium/ferdium-app/issues) for a bug report similar to mine, in vain |
22 | validations: | 22 | required: true |
23 | required: true | 23 | - type: textarea |
24 | - type: textarea | 24 | attributes: |
25 | attributes: | 25 | label: Steps to reproduce |
26 | label: Debug link | 26 | description: Explain to us how we can reproduce your bug on our computer |
27 | description: Get your debug link via Ferdium's "Help" > "Publish Debug Information", then share your link with us | 27 | placeholder: | |
28 | validations: | 28 | 1. Go to '...' |
29 | required: true | 29 | 2. Click on '....' |
30 | - type: textarea | 30 | 3. Scroll down to '....' |
31 | attributes: | 31 | 4. See error |
32 | label: Screenshots | 32 | validations: |
33 | description: If applicable, add screenshots to help visualize your problem | 33 | required: true |
34 | - type: textarea | 34 | - type: input |
35 | attributes: | 35 | attributes: |
36 | label: Additional information | 36 | label: Debug link |
37 | description: If your problem needs further explanation, please add more information here | 37 | description: Please get your debug link via Ferdium's "Help" > "Publish Debug Information", then share your link with us |
38 | validations: | ||
39 | required: false | ||
40 | - type: textarea | ||
41 | attributes: | ||
42 | label: Screenshots | ||
43 | description: If applicable, add screenshots to help visualize your problem | ||
44 | - type: textarea | ||
45 | attributes: | ||
46 | label: Additional information | ||
47 | description: If your problem needs further explanation, please add more information here | ||
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index faf53ba74..bd3124234 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml | |||
@@ -1,4 +1,4 @@ | |||
1 | # blank_issues_enabled: false | 1 | blank_issues_enabled: false |
2 | contact_links: | 2 | contact_links: |
3 | - name: Frequently Asked Questions | 3 | - name: Frequently Asked Questions |
4 | url: https://ferdium.org/faq/ | 4 | url: https://ferdium.org/faq/ |
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 5b2e6e30f..f39421976 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml | |||
@@ -1,48 +1,48 @@ | |||
1 | name: Feature Request | 1 | name: Feature Request |
2 | description: Suggest an idea for Ferdium | 2 | description: Suggest an idea for Ferdium |
3 | title: "" | 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 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) |
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 requesting support for a new service in Ferdium, please log it [here](https://github.com/ferdium/ferdium-recipes/pulls) |
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 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. |
12 | 4. Please fill our form below, this way we can analyse and fix the problem as fast as possible. | 12 | 4. Please fill our form below, this way we can analyse and fix the problem as fast as possible. |
13 | 5. Please consider supporting Ferdium! | 13 | 5. Please consider supporting Ferdium! |
14 | π https://github.com/sponsors/ferdium | 14 | π https://github.com/sponsors/ferdium |
15 | π https://opencollective.com/ferdium/donate | 15 | π https://opencollective.com/ferdium/donate |
16 | - type: checkboxes | 16 | - type: checkboxes |
17 | attributes: | 17 | attributes: |
18 | label: Preflight Checklist | 18 | label: Preflight Checklist |
19 | description: Please ensure you've completed all of the following. | 19 | description: Please ensure you've completed all of the following. |
20 | options: | 20 | options: |
21 | - label: I have read the [Contributing Guidelines](https://github.com/ferdium/ferdium-app/blob/develop/CONTRIBUTING.md) for this project. | 21 | - label: I have read the [Contributing Guidelines](https://github.com/ferdium/ferdium-app/blob/develop/CONTRIBUTING.md) for this project. |
22 | required: true | 22 | required: true |
23 | - 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. | 23 | - 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. |
24 | required: true | 24 | required: true |
25 | - 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. | 25 | - 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. |
26 | required: true | 26 | required: true |
27 | - type: textarea | 27 | - type: textarea |
28 | attributes: | 28 | attributes: |
29 | label: Problem Description | 29 | label: Problem Description |
30 | description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | 30 | description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] |
31 | validations: | 31 | validations: |
32 | required: true | 32 | required: true |
33 | - type: textarea | 33 | - type: textarea |
34 | attributes: | 34 | attributes: |
35 | label: Proposed Solution | 35 | label: Proposed Solution |
36 | description: A clear and concise description of what you want to happen. | 36 | description: A clear and concise description of what you want to happen. |
37 | validations: | 37 | validations: |
38 | required: true | 38 | required: true |
39 | - type: textarea | 39 | - type: textarea |
40 | attributes: | 40 | attributes: |
41 | label: Alternatives Considered | 41 | label: Alternatives Considered |
42 | description: A clear and concise description of any alternative solutions or features you've considered. | 42 | description: A clear and concise description of any alternative solutions or features you've considered. |
43 | validations: | 43 | validations: |
44 | required: true | 44 | required: true |
45 | - type: textarea | 45 | - type: textarea |
46 | attributes: | 46 | attributes: |
47 | label: Additional Information | 47 | label: Additional Information |
48 | description: Add any other context or screenshots about the feature request here. | 48 | description: Add any other context or screenshots about the feature request here. |
diff --git a/.github/ISSUE_TEMPLATE/open_issue.yml b/.github/ISSUE_TEMPLATE/open_issue.yml index 7a8b22535..ba9c8715b 100644 --- a/.github/ISSUE_TEMPLATE/open_issue.yml +++ b/.github/ISSUE_TEMPLATE/open_issue.yml | |||
@@ -1,13 +1,19 @@ | |||
1 | name: Open issue | 1 | name: 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/fedium-recipes/issues) |
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-recipes/pulls) |
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. Please fill our form below, this way we can analyse and fix the problem as fast as possible. | 10 | 4. Please consider supporting Ferdium! |
11 | 5. Please consider supporting Ferdium! | 11 | π https://github.com/sponsors/ferdium |
12 | π https://github.com/sponsors/ferdium | 12 | π https://opencollective.com/ferdium/donate |
13 | π https://opencollective.com/ferdium/donate | 13 | |
14 | - type: textarea | ||
15 | attributes: | ||
16 | label: "Your issue" | ||
17 | description: "Describe your issue" | ||
18 | validations: | ||
19 | required: true | ||