From 6d32bd0f5f2bf842e2837d6d18385761c8bd22aa Mon Sep 17 00:00:00 2001 From: ChunkyProgrammer <78101139+ChunkyProgrammer@users.noreply.github.com> Date: Fri, 7 Jan 2022 22:34:34 -0500 Subject: [PATCH] Switch to yaml issue templates (forms) (#1593) * Delete bug_report.md * Delete discussion.md * Delete question.md * Delete feature_request.md * Create bug_report.yaml * Create config.yml * Create discussion.yaml * Create feature_request.yaml * Create question.yaml * Fix dropdown list * Update bug_report.yaml * Update feature_request.yaml * added checkbox for duplicate issue * removed label icons * Update bug_report.yaml * replaced checkboxes in dropdowns * Update bug_report.yaml * Update feature_request.yaml * Update question.yaml * Update question.yaml * Update question.yaml * Update discussion.yaml * Update bug_report.yaml * Update bug_report.yaml * Update bug_report.yaml * Update feature_request.yaml * Update feature_request.yaml * Update feature_request.yaml * Update feature_request.yaml * Update question.yaml * Update bug_report.yaml * removed discussion and question template * added readme and label * fixes hyperlinks * fix typo * fix I * fixed I * Create autoLabelIssue.yaml * Update bug_report.yaml * added description, changed required to true and moved the codeblock * moved labels dropdown to logical place * added all bug labels * added enhancement labels * label api issue added * new feature label added Co-authored-by: efb4f5ff-1298-471a-8973-3d47447115dc <73130443+efb4f5ff-1298-471a-8973-3d47447115dc@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug_report.md | 43 -------- .github/ISSUE_TEMPLATE/bug_report.yaml | 116 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/discussion.md | 22 ---- .github/ISSUE_TEMPLATE/feature_request.md | 27 ----- .github/ISSUE_TEMPLATE/feature_request.yaml | 57 ++++++++++ .github/ISSUE_TEMPLATE/question.md | 22 ---- .github/workflows/autoLabelIssue.yaml | 14 +++ 8 files changed, 188 insertions(+), 114 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/discussion.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml delete mode 100644 .github/ISSUE_TEMPLATE/question.md create mode 100644 .github/workflows/autoLabelIssue.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index d9595c99..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -name: Bug report -about: Report an issue or unexpected behavior that occurs within the application -title: '' -labels: bug -assignees: '' - ---- - -**README: Before You Submit Your Issue** -- Please check other open and closed issues for a similar bug before reporting a new one. -- Make sure you are on the latest release of FreeTube before submitting an issue. -- Remove this notice before posting. - -**Behavior of the program** -Please write a clear and concise description of what the bug is. - -**Expected behavior** -Please describe clear and concise what you expected to happen. - -**To Reproduce** -Please add all steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Link to video** -If you refer to a problem which occurs within a specific video, or a range of videos, please link at least one here. - -**Screenshots** -If applicable, please add screenshots to help explain your problem. Especially console logs from the development tools are very helpful. - -**Environment Information (please complete the following information):** - - OS: [e.g. Windows, Mac, Ubuntu, Fedora, Arch, etc.] - - OS Version: [e.g. Windows 10, Ubuntu 20.04] - - FreeTube version: [e.g. 0.9.0, Nightly build?] - - Installation Method (If applicable): [e.g. Portable, .exe, .deb, .AppImage, FlatHub] - - Primary API Used: [Local API, Invidious API] - - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 00000000..f139b29d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,116 @@ +name: Bug Report +description: Report an issue or unexpected behavior that occurs within the application +title: "[Bug]: " +labels: "bug" +body: + - type: markdown + attributes: + value: | + **README: Before You Submit Your Issue** + - Issues are not a place to go ask support questions or start discussions. Please ask support questions or start discussions on the [discussions page](https://github.com/FreeTubeApp/FreeTube/discussions). + - type: checkboxes + attributes: + label: Guidelines + description: Please ensure you've completed all of the following. + options: + - label: I have encountered this bug in the [latest release of FreeTube](https://github.com/FreeTubeApp/FreeTube/releases). + required: true + - label: I have searched the [issue tracker](https://github.com/FreeTubeApp/FreeTube/issues) for a bug report that matches the one I want to file, without success. + required: true + - type: textarea + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + 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: dropdown + attributes: + label: 'Issue Labels' + description: Please select a label that fits this bug report. Choose multiple, if applicable. + multiple: true + options: + - accessibility issue + - API issue + - causes crash + - content not loading + - data loss + - feature stopped working + - inconsistent behavior + - keyboard control not working + - only happens in developer mode + - race condition + - text/string issue + - usability issue + - visual bug + validations: + required: true + - type: input + attributes: + label: FreeTube Version + description: | + If using releases, enter the version. + If using nightly builds, enter commit hash or build number, you can find it via about page in the FreeTube application. + placeholder: v0.14.0, 8c4278 + 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, 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: 'Installation Method (If applicable)' + options: + - .AppImage + - .deb + - .dmg + - .exe + - Flathub + - Portable + - .rpm + - .zip + - other + validations: + required: false + - type: input + attributes: + label: 'Last Known Working FreeTube Version (If Any)' + description: What is the last version of FreeTube this worked in, if applicable? + placeholder: v0.14.0 + - type: dropdown + attributes: + label: Primary API used + description: What is the primary API being used? + multiple: false + options: + - Local API + - Invidious API + validations: + required: false + - type: textarea + attributes: + label: Additional Information + description: | + Add additional information here. + You may drag-and-drop screenshots/videos and log files here, or paste the log file in code blocks. + - type: checkboxes + attributes: + label: Nightly Build + description: Please ensure you've completed the following, if applicable. + options: + - label: I have encountered this bug in the latest [nightly build](https://docs.freetubeapp.io/development/nightly-builds). + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..3ba13e0c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/discussion.md b/.github/ISSUE_TEMPLATE/discussion.md deleted file mode 100644 index 2094b2e8..00000000 --- a/.github/ISSUE_TEMPLATE/discussion.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -name: Discussion -about: Open up a new discussion about anything related to the project. -title: '' -labels: Discussion -assignees: '' - ---- - -**Important note** -Please check other open and closed issues for a similar discussion or a question relating to your discussion before posting a new one. - -**Topic** -Please select what topic your discussion is about. -- [ ] Coding -- [ ] Contribution -- [ ] Languages -- [ ] Setup -- [ ] Other. Please specify: - -**Discussion** -Please write down whatever you want to discuss. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index d31ead5e..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project which you would like to see in a future release -title: '' -labels: enhancement -assignees: '' - ---- - -**Important note** -Please check other open and closed issues for a similar feature request before proposing a new one. -Also please leave all headers except this one in the issue, so that it is clear what belongs where. - -**Is your feature request related to a usage problem (not a bug)? Please describe.** -Please describe clear and concise of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like to see implemented** -Please give a clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -Are there other ways to solve the problem? Please give a clear and concise description of any alternative solutions or features you might have considered. - -**Screenshots** -Sometimes people have screenshots from mock-ups or other projects. Add them here. - -**Additional context** -Add any other context about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 00000000..acf119bc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,57 @@ +name: Feature request +description: Suggest an idea for FreeTube which you would like to see in a future release +title: "[Feature Request]: " +labels: "enhancement" +body: + - type: markdown + attributes: + value: | + **README: Before You Submit Your Issue** + - Issues are not a place to go ask support questions or start discussions. Please ask support questions or start discussions on the [discussions page](https://github.com/FreeTubeApp/FreeTube/discussions). + - type: checkboxes + attributes: + label: Guidelines + description: Please ensure you've completed all of the following. + options: + - label: I have searched the [issue tracker](https://github.com/FreeTubeApp/FreeTube/issues) for a feature request that matches the one I want to file, without success. + required: true + - type: textarea + attributes: + label: Problem Description + description: Please add a clear and concise description of the problem you are seeking to solve with this feature request. + validations: + required: true + - type: textarea + attributes: + label: Proposed Solution + description: Describe the solution you'd like in a clear and concise manner. + 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: dropdown + attributes: + label: 'Issue Labels' + description: Please select a label that fits this feature request. Choose multiple, if applicable. + multiple: true + options: + - display more information to user + - ease of use improvement + - improvement to existing feature + - new feature + - new keyboard shortcut + - new optional setting + - support for external software + - visual improvement + validations: + required: true + - type: textarea + attributes: + label: Additional Information + description: | + Add any other context or screenshots/videos about the feature request here. + You may drag-and-drop screenshots. diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index 4bd43b1c..00000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -name: Question -about: Ask a question which is not a bug or a feature request -title: '' -labels: question -assignees: '' - ---- - -**Important note** -Please check other open and closed issues for a similar question before posting a new one. - -**Topic** -Please select what topic you are referring to. -- [ ] Coding -- [ ] Contribution -- [ ] Languages -- [ ] Setup -- [ ] Other. Please specify: - -**Question** -Please write down your question. diff --git a/.github/workflows/autoLabelIssue.yaml b/.github/workflows/autoLabelIssue.yaml new file mode 100644 index 00000000..470ddd07 --- /dev/null +++ b/.github/workflows/autoLabelIssue.yaml @@ -0,0 +1,14 @@ +name: "Set Issue Label and Assignee" +on: + issues: + types: [opened] + +jobs: + label_issue: + runs-on: ubuntu-latest + steps: + - uses: Naturalclar/issue-action@v2.0.2 + with: + body: "both" + parameters: '[ {"keywords": ["visual bug"], "labels": ["B: visual"]}, {"keywords": ["keyboard control not working"], "labels": ["B: keyboard control"]}, {"keywords": ["text/string issue"], "labels": ["B: text/string"]}, {"keywords": ["content not loading"], "labels": ["B: content not loading"]}, {"keywords": ["accessibility issue"], "labels": ["B: accessibility"]}, {"keywords": ["usability issue"], "labels": ["B: usability"]}, {"keywords": ["causes crash"], "labels": ["B: crash"]}, {"keywords": ["feature stopped working"], "labels": ["B: feature stopped working"]}, {"keywords": ["inconsistent behavior"], "labels": ["B: inconsistent behavior"]}, {"keywords": ["data loss"], "labels": ["B: data loss"]}, {"keywords": ["race condition"],{"keywords": ["API issue"], "labels": ["B: API issue"]}, "labels": ["B: race condition"]}, {"keywords": ["only happens in developer mode"], "labels": ["B: developer mode"]}, {"keywords": ["improvement to existing feature"], "labels": ["E: improvement existing feature"]}, {"keywords": ["new optional setting"], "labels": ["E: new optional setting"]}, {"keywords": ["visual improvement"], "labels": ["E: visual improvement"]}, {"keywords": ["display more information to user"], "labels": ["E: display more information"]}, {"keywords": ["ease of use improvement"], "labels": ["E: ease of use improvement"]}, {"keywords": ["support for external software"], "labels": ["E: support external software"]}, {"keywords": ["new keyboard shortcut"], "labels": ["E: new feature"]}, {"keywords": ["new feature"], "labels": ["E: keyboard shortcut"]}]' + github-token: "${{ secrets.GITHUB_TOKEN }}" \ No newline at end of file