From 9a03c8b8c3c1dbfb802a69105faa82dca4673934 Mon Sep 17 00:00:00 2001 From: Vijay Aravamudhan Date: Thu, 18 Nov 2021 07:14:01 +0530 Subject: Revamped github Issue templates (new yml syntax) [skip ci] (#1441) --- .github/ISSUE_TEMPLATE/bug_report.md | 45 ----------- .github/ISSUE_TEMPLATE/bug_report.yml | 121 +++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 ++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ----- .github/ISSUE_TEMPLATE/feature_request.yml | 48 ++++++++++++ .github/ISSUE_TEMPLATE/open_issue.md | 8 -- .github/ISSUE_TEMPLATE/open_issue.yml | 13 ++++ .github/config.yml | 17 ++++ 8 files changed, 204 insertions(+), 73 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml delete mode 100644 .github/ISSUE_TEMPLATE/open_issue.md create mode 100644 .github/ISSUE_TEMPLATE/open_issue.yml create mode 100644 .github/config.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 020d6ff58..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve ---- - -**Bug description:** - - -**Steps to reproduce:** - - -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** - - -**Screenshots** - - - -**Environment:** - -- Operating System: -- Ferdi Version: -- Server: - -- Debug information: - - - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..8ca304efb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,121 @@ +name: Bug Report +description: Report an Ferdi bug +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/getferdi/recipes/issues) + 2. If you are requesting support for a new service in Ferdi, please log it [here](https://github.com/getferdi/recipes/pulls) + 3. Please remember to read the [self-help documentation](https://github.com/getferdi/ferdi#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. + 5. Please consider supporting Ferdi! + 👉 https://github.com/sponsors/getferdi + 👉 https://opencollective.com/getferdi/donate +- 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/getferdi/ferdi/blob/develop/CONTRIBUTING.md) for this project. + required: true + - label: I agree to follow the [Code of Conduct](https://github.com/getferdi/ferdi/blob/develop/CODE_OF_CONDUCT.md) that this project adheres to. + required: true + - label: I have searched the [issue tracker](https://github.com/getferdi/ferdi/issues) for a feature request that matches the one I want to file, without success. + required: true +- type: input + attributes: + label: Ferdi Version + description: What version of Ferdi are you using? + placeholder: 5.5.0 + validations: + required: true +- type: dropdown + attributes: + label: What operating system are you using? + options: + - Windows + - macOS + - Ubuntu + - Other Linux + - Other (specify below) + validations: + required: true +- type: dropdown + attributes: + label: Server + options: + - Ferdi + - Franz + - Using without an account + - Other server (please specify in the steps to reproduce) + validations: + required: true +- type: input + attributes: + label: Operating System Version + description: What operating system version are you using? On Windows, click Start button > Settings > System > About. On macOS, click the Apple Menu > About This Mac. On Linux, inside a terminal session, use lsb_release or uname -a. + placeholder: "e.g. Windows 10 version 1909, macOS Catalina 10.15.7, or Ubuntu 20.04" + validations: + required: true +- type: dropdown + attributes: + label: What arch are you using? + options: + - x64 + - ia32 + - arm64 (including Apple Silicon) + - Other (specify below) + validations: + required: true +- type: input + attributes: + label: Last Known working version of Ferdi + description: What is the last version of Ferdi this worked in, if applicable? + placeholder: 5.5.0 +- type: input + attributes: + label: Git SHA and/or build date + description: In the latest versions of Ferdi, we now also expose the GIT SHA and the build date. IF you are running one such version, please include this information as well. + placeholder: 9b29f041 / Sun May 09 2021 12:35:48 GMT+0200 +- type: textarea + attributes: + label: Steps to reproduce + description: Explain to us how we can reproduce your bug on our computer + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: true +- type: textarea + attributes: + label: Expected Behavior + description: A clear and concise description of what you expected to happen. + validations: + required: true +- type: textarea + attributes: + label: Actual Behavior + description: A clear description of what actually happens. + validations: + required: true +- type: textarea + attributes: + label: Screenshots + 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 +- type: textarea + attributes: + label: Debug information + description: Get your debug information via Ferdi "Help" menu ("Copy/Publish Debug Information") then share a debug information file or your published link with us. +- type: input + attributes: + label: Testcase Gist URL + description: If you can reproduce the issue in a standalone test case, please use [Electron Fiddle](https://github.com/electron/fiddle) to create one and to publish it as a [GitHub gist](https://gist.github.com) and put the gist URL here. This is **the best way** to ensure this issue is triaged quickly **and** does not regress in the future. + placeholder: https://gist.github.com/... +- type: textarea + attributes: + label: Additional Information + 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/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..69c57897d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +# blank_issues_enabled: false +contact_links: + - name: Ferdi Community Support + url: https://help.getferdi.com/ + about: Please see some basic questions here. If your question is not answered, please continue with raising an issue in github. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 61353797c..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. - - diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..3662edffd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,48 @@ +name: Feature Request +description: Suggest an idea for Ferdi +title: "[Feature Request]: " +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/getferdi/recipes/issues) + 2. If you are requesting support for a new service in Ferdi, please log it [here](https://github.com/getferdi/recipes/pulls) + 3. Please remember to read the [self-help documentation](https://github.com/getferdi/ferdi#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. + 5. Please consider supporting Ferdi! + 👉 https://github.com/sponsors/getferdi + 👉 https://opencollective.com/getferdi/donate +- 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/getferdi/ferdi/blob/develop/CONTRIBUTING.md) for this project. + required: true + - label: I agree to follow the [Code of Conduct](https://github.com/getferdi/ferdi/blob/develop/CODE_OF_CONDUCT.md) that this project adheres to. + required: true + - label: I have searched the [issue tracker](https://github.com/getferdi/ferdi/issues) for a feature request that matches the one I want to file, without success. + required: true +- type: textarea + attributes: + label: Problem Description + description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + validations: + required: true +- type: textarea + attributes: + label: Proposed Solution + description: A clear and concise description of what you want to happen. + validations: + required: true +- type: textarea + attributes: + label: Alternatives Considered + description: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: true +- type: textarea + attributes: + label: Additional Information + description: Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/open_issue.md b/.github/ISSUE_TEMPLATE/open_issue.md deleted file mode 100644 index c7c279643..000000000 --- a/.github/ISSUE_TEMPLATE/open_issue.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -name: Open issue -about: For everything that's neither a feature request, nor a bug ---- - - diff --git a/.github/ISSUE_TEMPLATE/open_issue.yml b/.github/ISSUE_TEMPLATE/open_issue.yml new file mode 100644 index 000000000..947b94459 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/open_issue.yml @@ -0,0 +1,13 @@ +name: Open 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/getferdi/recipes/issues) + 2. If you are requesting support for a new service in Ferdi, please log it [here](https://github.com/getferdi/recipes/pulls) + 3. Please remember to read the [self-help documentation](https://github.com/getferdi/ferdi#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. + 5. Please consider supporting Ferdi! + 👉 https://github.com/sponsors/getferdi + 👉 https://opencollective.com/getferdi/donate diff --git a/.github/config.yml b/.github/config.yml new file mode 100644 index 000000000..237e3f570 --- /dev/null +++ b/.github/config.yml @@ -0,0 +1,17 @@ +# Comment to be posted to on PRs from first time contributors in your repository +newPRWelcomeComment: | + 💖 Thanks for opening this pull request! 💖 + + Things that will help get your PR across the finish line: + + - Follow the JavaScript [coding style](https://github.com/electron/electron/blob/master/docs/development/coding-style.md) as recommended by the Electron project. + - Run `npm run lint` locally to catch formatting errors earlier. + - Document any user-facing changes you've made by including screenshots and animated GIFs whenever possible. + + We get a lot of pull requests on this repo, so please be patient and we will get back to you as soon as we can. + +# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge + +# Comment to be posted to on pull requests merged by a first time user +firstPRMergeComment: > + Congrats on merging your first pull request! 🎉🎉🎉 -- cgit v1.2.3-70-g09d2