diff options
Diffstat (limited to '.github')
-rw-r--r-- | .github/ISSUE_TEMPLATE/app_bug_report.yml (renamed from .github/ISSUE_TEMPLATE/bug_report.yml) | 16 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/app_feature_request.yml (renamed from .github/ISSUE_TEMPLATE/feature_request.yml) | 21 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/recipe_bug_report.yml | 75 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/recipe_request.yml | 48 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/something_else_open_issue.yml (renamed from .github/ISSUE_TEMPLATE/open_issue.yml) | 9 | ||||
-rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 12 |
6 files changed, 147 insertions, 34 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/app_bug_report.yml index 264f94ef3..5e4afeacd 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/app_bug_report.yml | |||
@@ -1,22 +1,20 @@ | |||
1 | name: Bug report | 1 | name: App - Bug report |
2 | description: Report a bug in Ferdium | 2 | description: Report a bug in the Ferdium app |
3 | title: "Bug: " | ||
4 | labels: ["bug :beetle:"] | 3 | labels: ["bug :beetle:"] |
5 | body: | 4 | body: |
6 | - type: markdown | 5 | - type: markdown |
7 | attributes: | 6 | attributes: |
8 | value: | | 7 | 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) | 8 | 1. Please fill our form below, this way we can analyse and fix the problem as fast as possible. |
10 | 2. If you are requesting support for a new service in Ferdium, please log it [here](https://github.com/ferdium/ferdium-recipes/pulls) | 9 | 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. | ||
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 | 10 | - type: checkboxes |
15 | attributes: | 11 | attributes: |
16 | label: Avoid duplicates | 12 | label: Avoid duplicates |
17 | description: Please ensure you've completed the following | 13 | description: Please ensure you've completed the following |
18 | options: | 14 | options: |
19 | - label: I have searched the [issues tracker](https://github.com/ferdium/ferdium-app/issues) for a bug report similar to mine, in vain | 15 | - label: I agree to follow the [Code of Conduct](https://github.com/ferdium/ferdium-app/blob/HEAD/CODE_OF_CONDUCT.md) that this project adheres to. |
16 | required: true | ||
17 | - label: I have searched the [issues tracker](https://github.com/ferdium/ferdium-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22bug+%3Abeetle%3A%22) for a bug report similar to mine, in vain | ||
20 | required: true | 18 | required: true |
21 | - type: input | 19 | - type: input |
22 | attributes: | 20 | attributes: |
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/app_feature_request.yml index e10512398..0b7706ace 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/app_feature_request.yml | |||
@@ -1,31 +1,28 @@ | |||
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: " | ||
4 | labels: ["enhancement :sparkles:"] | 3 | labels: ["enhancement :sparkles:"] |
5 | body: | 4 | body: |
6 | - type: markdown | 5 | - type: markdown |
7 | attributes: | 6 | attributes: |
8 | value: | | 7 | 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) | 8 | 1. Please fill our form below, this way we can analyse and fix the problem as fast as possible. |
10 | 2. If you are requesting support for a new service in Ferdium, please log it [here](https://github.com/ferdium/ferdium-recipes/pulls) | 9 | 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. | ||
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 | 10 | - type: checkboxes |
15 | attributes: | 11 | attributes: |
16 | label: Preflight Checklist | 12 | label: Preflight Checklist |
17 | description: Please ensure you've completed all of the following. | 13 | description: Please ensure you've completed all of the following. |
18 | options: | 14 | options: |
19 | - label: I have read the [Contributing Guidelines](https://github.com/ferdium/ferdium-app/blob/develop/CONTRIBUTING.md) for this project. | 15 | - label: I have read the [Contributing Guidelines](https://github.com/ferdium/ferdium-app/blob/HEAD/CONTRIBUTING.md) for this project. |
20 | required: true | 16 | required: true |
21 | - 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. | 17 | - label: I agree to follow the [Code of Conduct](https://github.com/ferdium/ferdium-app/blob/HEAD/CODE_OF_CONDUCT.md) that this project adheres to. |
22 | required: true | 18 | required: true |
23 | - 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. | 19 | - label: I have searched the [issue tracker](https://github.com/ferdium/ferdium-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22enhancement+%3Asparkles%3A%22) for a feature request that matches the one I want to file, without success. |
24 | required: true | 20 | required: true |
25 | - type: textarea | 21 | - type: textarea |
26 | attributes: | 22 | attributes: |
27 | label: Problem Description | 23 | label: Problem Description |
28 | description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | 24 | description: A clear and concise description of what the problem is. |
25 | placeholder: Ex. I'm always frustrated when [...] | ||
29 | validations: | 26 | validations: |
30 | required: true | 27 | required: true |
31 | - type: textarea | 28 | - type: textarea |
diff --git a/.github/ISSUE_TEMPLATE/recipe_bug_report.yml b/.github/ISSUE_TEMPLATE/recipe_bug_report.yml new file mode 100644 index 000000000..79c2600ec --- /dev/null +++ b/.github/ISSUE_TEMPLATE/recipe_bug_report.yml | |||
@@ -0,0 +1,75 @@ | |||
1 | name: Recipes - Bug Report | ||
2 | description: Report a bug in a Ferdium Recipe for a particular service | ||
3 | labels: ["bug :beetle:", "recipe :bookmark_tabs:"] | ||
4 | body: | ||
5 | - type: markdown | ||
6 | attributes: | ||
7 | value: | | ||
8 | 1. Please fill our form below, this way we can analyse and fix the problem as fast as possible. | ||
9 | 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. | ||
10 | - type: checkboxes | ||
11 | attributes: | ||
12 | label: Preflight Checklist | ||
13 | description: Please ensure you've completed all of the following. | ||
14 | options: | ||
15 | - label: I agree to follow the [Code of Conduct](https://github.com/ferdium/ferdium-app/blob/HEAD/CODE_OF_CONDUCT.md) that Ferdium Recipes adheres to. | ||
16 | required: true | ||
17 | - 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. | ||
18 | required: true | ||
19 | - type: input | ||
20 | attributes: | ||
21 | label: Ferdium Version | ||
22 | description: What version of Ferdium are you using? | ||
23 | placeholder: 5.6.3 | ||
24 | validations: | ||
25 | required: true | ||
26 | - type: input | ||
27 | attributes: | ||
28 | label: Recipe Name | ||
29 | description: What is the name of the specific recipe you are using? | ||
30 | placeholder: WhatsApp | ||
31 | validations: | ||
32 | required: true | ||
33 | - type: input | ||
34 | attributes: | ||
35 | label: Recipe Version | ||
36 | description: What version of the specific recipe are you using? | ||
37 | placeholder: 1.0.0 | ||
38 | validations: | ||
39 | required: true | ||
40 | - type: input | ||
41 | attributes: | ||
42 | label: Last Known working version of the recipe | ||
43 | description: What is the last version of the recipe this worked in, if applicable? | ||
44 | placeholder: 1.0.0 | ||
45 | - type: textarea | ||
46 | attributes: | ||
47 | label: Steps to reproduce | ||
48 | description: Explain to us how we can reproduce your bug on our computer | ||
49 | placeholder: | | ||
50 | 1. Go to '...' | ||
51 | 2. Click on '....' | ||
52 | 3. Scroll down to '....' | ||
53 | 4. See error | ||
54 | validations: | ||
55 | required: true | ||
56 | - type: textarea | ||
57 | attributes: | ||
58 | label: Expected Behavior | ||
59 | description: A clear and concise description of what you expected to happen. | ||
60 | validations: | ||
61 | required: true | ||
62 | - type: textarea | ||
63 | attributes: | ||
64 | label: Actual Behavior | ||
65 | description: A clear description of what actually happens. | ||
66 | validations: | ||
67 | required: true | ||
68 | - type: textarea | ||
69 | attributes: | ||
70 | label: Screenshots | ||
71 | 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 | ||
72 | - type: textarea | ||
73 | attributes: | ||
74 | label: Additional Information | ||
75 | 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..456c116bb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/recipe_request.yml | |||
@@ -0,0 +1,48 @@ | |||
1 | name: Recipes - New Service Request | ||
2 | description: Suggest a service that we should add to Ferdium Recipes | ||
3 | labels: ["recipe request :sparkles:", "recipe :bookmark_tabs:"] | ||
4 | body: | ||
5 | - type: markdown | ||
6 | attributes: | ||
7 | value: | | ||
8 | Before creating a new recipe request, **please check if you can add it yourself**. | ||
9 | If you add a recipe yourself, it will be added faster than having to go through other contributors to do this job for you. | ||
10 | |||
11 | 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"). | ||
12 | 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. | ||
13 | |||
14 | 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). | ||
15 | |||
16 | **If you are not familiar with JavaScript:** Please still search for a recipe using the guide above and add it to your request. | ||
17 | - type: checkboxes | ||
18 | attributes: | ||
19 | label: Preflight Checklist | ||
20 | description: Please ensure you've completed all of the following. | ||
21 | options: | ||
22 | - label: I agree to follow the [Code of Conduct](https://github.com/ferdium/ferdium-app/blob/HEAD/CODE_OF_CONDUCT.md) that Ferdium Recipes adheres to. | ||
23 | required: true | ||
24 | - 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. | ||
25 | required: true | ||
26 | - type: input | ||
27 | attributes: | ||
28 | label: Name of the service | ||
29 | description: What is the name of the service you are requesting? | ||
30 | placeholder: WhatsApp | ||
31 | validations: | ||
32 | required: true | ||
33 | - type: input | ||
34 | attributes: | ||
35 | label: URL of the service | ||
36 | description: What is the URL of the service you are requesting? | ||
37 | placeholder: https://web.whatsapp.com | ||
38 | - type: input | ||
39 | attributes: | ||
40 | label: GitHub URL to a recipe that has already been created by someone else or you | ||
41 | description: What is the URL of the service-recipe? | ||
42 | placeholder: https://github.com/... | ||
43 | - type: textarea | ||
44 | attributes: | ||
45 | label: Features you want implemented | ||
46 | description: A clear and concise description of what features you want implemented eg Notification support | ||
47 | validations: | ||
48 | required: true | ||
diff --git a/.github/ISSUE_TEMPLATE/open_issue.yml b/.github/ISSUE_TEMPLATE/something_else_open_issue.yml index fd643cafb..41e6f9187 100644 --- a/.github/ISSUE_TEMPLATE/open_issue.yml +++ b/.github/ISSUE_TEMPLATE/something_else_open_issue.yml | |||
@@ -1,13 +1,12 @@ | |||
1 | name: Open empty issue | 1 | name: Open an 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. 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 | 10 | - type: textarea |
12 | attributes: | 11 | attributes: |
13 | label: "Your issue" | 12 | label: "Your issue" |
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 44abd46f8..3a9eb4477 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md | |||
@@ -5,14 +5,10 @@ | |||
5 | 5 | ||
6 | #### Pre-flight Checklist | 6 | #### Pre-flight Checklist |
7 | 7 | ||
8 | 1. Please remember that if you are logging a bug for some service that has _stopped working_ or is _working incorrectly_, please log the bug [here](https://github.com/ferdium/ferdium-recipes/issues) | 8 | Please ensure you've completed all of the following. |
9 | 2. If you are requesting support for a **new service** in Ferdium, please log it [here](https://github.com/ferdium/ferdium-recipes/pulls) | 9 | |
10 | 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 older versions of recipes that were installed on your machine. (These will get automatically upgraded when you upgrade to the newer versions of Ferdium, but to get new recipes between Ferdium releases, this documentation is quite useful.) | 10 | - [ ] I have read the [Contributing Guidelines](https://github.com/ferdium/ferdium-app/blob/HEAD/CONTRIBUTING.md) for this project. |
11 | 4. Please ensure you've completed all of the following. | 11 | - [ ] I agree to follow the [Code of Conduct](https://github.com/ferdium/ferdium-app/blob/HEAD/CODE_OF_CONDUCT.md) that this project adheres to. |
12 | |||
13 | - [ ] I have read the [Contributing Guidelines](https://github.com/ferdium/ferdium-app/blob/develop/CONTRIBUTING.md) for this project. | ||
14 | - [ ] 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. | ||
15 | - [ ] 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. | ||
16 | 12 | ||
17 | #### Description of Change | 13 | #### Description of Change |
18 | <!-- Describe your changes in detail. --> | 14 | <!-- Describe your changes in detail. --> |