From 07714abe496094760c95a8fe1bfd651fd9f09ef5 Mon Sep 17 00:00:00 2001 From: oSumAtrIX Date: Tue, 26 Jul 2022 19:10:57 +0200 Subject: [PATCH] docs: GitHub issue forms --- .github/ISSUE_TEMPLATE/bug-issue.yml | 61 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 24 --------- .github/ISSUE_TEMPLATE/config.yml | 8 +++ .github/ISSUE_TEMPLATE/feature-issue.yml | 46 +++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 24 --------- 5 files changed, 115 insertions(+), 48 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug-issue.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-issue.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug-issue.yml b/.github/ISSUE_TEMPLATE/bug-issue.yml new file mode 100644 index 0000000..75fa817 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-issue.yml @@ -0,0 +1,61 @@ +name: 🐞 Bug report +description: Report a very clearly broken issue. +title: 'bug: ' +labels: [bug] +body: + - type: markdown + attributes: + value: | + # ReVanced bug report + + Important to note that your issue may have already been reported before. Please check for existing issues [here](https://github.com/revanced/revanced-cli/labels/bug) + + - type: dropdown + attributes: + label: Type + options: + - Error while running the CLI + - Error at runtime + - Cosmetic + - Other + validations: + required: true + - type: textarea + attributes: + label: Bug description + description: How did you find the bug? Any additional details that might help? + validations: + required: true + - type: textarea + attributes: + label: Steps to reproduce + description: Add the steps to reproduce this bug including your environment. + placeholder: Step 1. Download some files. Step 2. ... + validations: + required: true + - type: textarea + attributes: + label: Relevant log output + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell + validations: + required: true + - type: textarea + attributes: + label: Screenshots or videos + description: Add screenshots or videos that show the bug here. + placeholder: Drag and drop the screenshots/videos into this box. + validations: + required: false + - type: textarea + attributes: + label: Solution + description: If applicable, add a possible solution. + validations: + required: true + - type: textarea + attributes: + label: Additional context + description: Add additional context here. + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 484e4af..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: Bug report -about: Create a bug report on the CLI. Do not submit suggestions for patches here. -title: 'problem: some problem' -labels: bug -assignees: '' - ---- - -## 🐞 Issue - -<!-- Describe your issue in detail here --> - -## ⚙ Reproduce - -<!-- Include your environment and steps to reproduce the issue as detailed as possible --> - -## 🛠 Solution - -<!-- If applicable, add a possible solution --> - -## ⚠ Additional context - -<!-- Add any other context about the problem here --> diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..9f537ff --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: 📃 Documentation + url: https://github.com/revanced/revanced-documentation/ + about: Don't know how or where to start? Check out our documentation! + - name: 🗨 Discussions + url: https://github.com/revanced/revanced-suggestions/discussions + about: Got something you think should change or be added? Search for or start a new discussion! \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-issue.yml b/.github/ISSUE_TEMPLATE/feature-issue.yml new file mode 100644 index 0000000..cc48c3d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-issue.yml @@ -0,0 +1,46 @@ +name: ⭐ Feature request +description: Create a detailed feature request. +title: 'feat: <title>' +labels: [feature-request] +body: + - type: markdown + attributes: + value: | + # ReVanced feature request + + Do not submit requests for patches here. Please submit them [here](https://github.com/orgs/revanced/discussions/categories/patches) instead. + Important to note that your feature request may have already been made before. Please check for existing feature requests [here](https://github.com/revanced/revanced-cli/labels/feature-request) + + - type: dropdown + attributes: + label: Type + options: + - Functionality + - Cosmetic + - Other + validations: + required: true + - type: textarea + attributes: + label: Issue + description: What is the current problem. Why does it require a feature request? + validations: + required: true + - type: textarea + attributes: + label: Feature + description: Describe your feature in detail. How does it solve the issue? + validations: + required: true + - type: textarea + attributes: + label: Motivation + description: Why should your feature should be considered? + validations: + required: true + - type: textarea + attributes: + label: Additional context + description: Add additional context here. + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 1bddca2..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: Feature request -about: Suggest a change to the CLI. Do not submit suggestions for patches here. -title: 'feat: some feature' -labels: feature-request -assignees: '' - ---- - -## 🐞 Issue - -<!-- Describe your issue in detail here --> - -## ⚙ Reproduce - -<!-- Include your environment and steps to reproduce the issue as detailed as possible --> - -## 🛠 Solution - -<!-- If applicable, add a possible solution --> - -## ⚠ Additional context - -<!-- Add any other context about the problem here -->