aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLibravatar Nathanaƫl Houn <contact@nathanaelhoun.fr>2023-02-15 19:00:26 +0100
committerLibravatar Vijay Aravamudhan <vraravam@users.noreply.github.com>2023-02-16 09:40:30 +0530
commit933ee79769c257125eeba7f7e170e6b3ea6cf05a (patch)
tree694cb2f726b402e7ff1a34b8b7a05ca8cbc2f2d1
parentUpgrade 'electron' to '23.1.0' (diff)
downloadferdium-app-933ee79769c257125eeba7f7e170e6b3ea6cf05a.tar.gz
ferdium-app-933ee79769c257125eeba7f7e170e6b3ea6cf05a.tar.zst
ferdium-app-933ee79769c257125eeba7f7e170e6b3ea6cf05a.zip
docs: add issues templates from recipes
-rw-r--r--.github/ISSUE_TEMPLATE/app_bug_report.yml (renamed from .github/ISSUE_TEMPLATE/bug_report.yml)4
-rw-r--r--.github/ISSUE_TEMPLATE/app_feature_request.yml (renamed from .github/ISSUE_TEMPLATE/feature_request.yml)0
-rw-r--r--.github/ISSUE_TEMPLATE/recipe_bug_report.yml80
-rw-r--r--.github/ISSUE_TEMPLATE/recipe_request.yml56
4 files changed, 138 insertions, 2 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/app_bug_report.yml
index 264f94ef3..a253adca4 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/app_bug_report.yml
@@ -1,5 +1,5 @@
1name: Bug report 1name: App Bug report
2description: Report a bug in Ferdium 2description: Report a bug in the Ferdium App
3title: "Bug: " 3title: "Bug: "
4labels: ["bug :beetle:"] 4labels: ["bug :beetle:"]
5body: 5body:
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/app_feature_request.yml
index e10512398..e10512398 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.yml
+++ b/.github/ISSUE_TEMPLATE/app_feature_request.yml
diff --git a/.github/ISSUE_TEMPLATE/recipe_bug_report.yml b/.github/ISSUE_TEMPLATE/recipe_bug_report.yml
new file mode 100644
index 000000000..8bfc312b3
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/recipe_bug_report.yml
@@ -0,0 +1,80 @@
1name: Bug Report
2description: Report an Ferdium bug
3title: "[Bug]: "
4labels: ["bug :beetle:"]
5body:
6- type: markdown
7 attributes:
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)
10 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)
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.
13- type: checkboxes
14 attributes:
15 label: Preflight Checklist
16 description: Please ensure you've completed all of the following.
17 options:
18 - label: I have read the [Contributing Guidelines](https://github.com/ferdium/ferdium-app/blob/develop/CONTRIBUTING.md) for this project.
19 required: true
20 - label: I agree to follow the [Code of Conduct](https://github.com/ferdium/ferdium-recipes/blob/main/CODE_OF_CONDUCT.md) that this project adheres to.
21 required: true
22 - 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.
23 required: true
24- type: input
25 attributes:
26 label: Ferdium Version
27 description: What version of Ferdium are you using?
28 placeholder: 5.6.3
29 validations:
30 required: true
31- type: input
32 attributes:
33 label: Recipe Name
34 description: What is the name of the specific recipe you are using?
35 placeholder: 1.0.0
36 validations:
37 required: true
38- type: input
39 attributes:
40 label: Recipe Version
41 description: What version of the specific recipe are you using?
42 placeholder: 1.0.0
43 validations:
44 required: true
45- type: input
46 attributes:
47 label: Last Known working version of the recipe
48 description: What is the last version of the recipe this worked in, if applicable?
49 placeholder: 1.0.0
50- type: textarea
51 attributes:
52 label: Steps to reproduce
53 description: Explain to us how we can reproduce your bug on our computer
54 placeholder: |
55 1. Go to '...'
56 2. Click on '....'
57 3. Scroll down to '....'
58 4. See error
59 validations:
60 required: true
61- type: textarea
62 attributes:
63 label: Expected Behavior
64 description: A clear and concise description of what you expected to happen.
65 validations:
66 required: true
67- type: textarea
68 attributes:
69 label: Actual Behavior
70 description: A clear description of what actually happens.
71 validations:
72 required: true
73- type: textarea
74 attributes:
75 label: Screenshots
76 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
77- type: textarea
78 attributes:
79 label: Additional Information
80 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..517d4fffd
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/recipe_request.yml
@@ -0,0 +1,56 @@
1name: New Service-recipe Request
2description: Suggest a service that we should add to Ferdium
3title: "[Recipe Request]: "
4labels: ["recipe request :sparkles:"]
5body:
6- type: markdown
7 attributes:
8 value: |
9 Before creating a new recipe request please check if you can add it yourself.
10 If you add a recipe yourself it will be added faster than having to go through other contributors to do this job for you.
11
12 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 "Franz" on Github (e.g "WhatsApp Franz"), optionally you can also add "recipe" to the search query (e.g. "WhatsApp Franz 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.
13 After finding a recipe you can let our fetch script add it to the repository for you. For this, please fork this repository on GitHub and follow the instructions on https://github.com/ferdium/ferdium-recipes#importing-recipes-from-github. After adding the recipe, please create a PR back to this repository.
14
15 If there is no repository on GitHub 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 this guide from Franz: https://github.com/meetfranz/plugins/blob/master/docs/integration.md.
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.
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)
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
24 attributes:
25 label: Preflight Checklist
26 description: Please ensure you've completed all of the following.
27 options:
28 - label: I have read the [Contributing Guidelines](https://github.com/ferdium/ferdium-recipes/blob/develop/CONTRIBUTING.md) for this project.
29 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.
31 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.
33 required: true
34- type: input
35 attributes:
36 label: Name of the service
37 description: What is the name of the service you are requesting?
38 placeholder: WhatsApp
39 validations:
40 required: true
41- type: input
42 attributes:
43 label: URL of the service
44 description: What is the URL of the service you are requesting?
45 placeholder: https://web.whatsapp.com
46- type: input
47 attributes:
48 label: GitHub URL to a recipe that has already been created by someone else or you
49 description: What is the URL of the service-recipe?
50 placeholder: https://github.com/...
51- type: textarea
52 attributes:
53 label: Features you want implemented
54 description: A clear and concise description of what features you want implemented eg Notification support
55 validations:
56 required: true