From c767f5254c369cc293029ce2d53e77cd5f0948cc Mon Sep 17 00:00:00 2001 From: TheCatLady <52870424+TheCatLady@users.noreply.github.com> Date: Fri, 15 Oct 2021 12:11:38 -0400 Subject: [PATCH] chore(github): issue forms (#2200) * chore(github): issue forms * chore(github): remove now-unneeded 'Invalid Template' action --- .github/ISSUE_TEMPLATE/bug.yml | 91 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 45 ----------- .github/ISSUE_TEMPLATE/config.yml | 6 +- .github/ISSUE_TEMPLATE/enhancement.yml | 37 +++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 19 ----- .github/workflows/invalid_template.yml | 19 ----- 6 files changed, 131 insertions(+), 86 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/enhancement.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 .github/workflows/invalid_template.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 00000000..39a838a9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,91 @@ +name: 🐛 Bug Report +description: Report a problem +labels: ['type:bug', 'awaiting-triage'] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + + Please note that we use GitHub issues exclusively for bug reports and feature requests. For support requests, please use our other support channels to get help. + - type: textarea + id: description + attributes: + label: Description + description: Please provide a clear and concise description of the bug or issue. + validations: + required: true + - type: input + id: version + attributes: + label: Version + description: What version of Overseerr are you running? (You can find this in Settings → About → Version.) + validations: + required: true + - type: textarea + id: repro-steps + attributes: + label: Steps to Reproduce + description: Please tell us how we can reproduce the undesired behavior. + placeholder: | + 1. Go to [...] + 2. Click on [...] + 3. Scroll down to [...] + 4. See error in [...] + validations: + required: true + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: If applicable, please provide screenshots depicting the problem. + - type: textarea + id: logs + attributes: + label: Logs + description: Please copy and paste any relevant log output. (This will be automatically formatted into code, so no need for backticks.) + render: shell + - type: dropdown + id: platform + attributes: + label: Platform + options: + - desktop + - smartphone + - tablet + validations: + required: true + - type: input + id: device + attributes: + label: Device + description: e.g., iPhone X, Surface Pro, Samsung Galaxy Tab + validations: + required: true + - type: input + id: os + attributes: + label: Operating System + description: e.g., iOS 8.1, Windows 10, Android 11 + validations: + required: true + - type: input + id: browser + attributes: + label: Browser + description: e.g., Chrome, Safari, Edge, Firefox + validations: + required: true + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Please provide any additional information that may be relevant or helpful. + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/sct/overseerr/blob/develop/CODE_OF_CONDUCT.md) + options: + - label: I agree to follow Overseerr's Code of Conduct + required: true diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 4b1d3790..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -name: Bug report -about: Submit a report to help us improve -title: '' -labels: 'awaiting-triage, type:bug' -assignees: '' ---- - -#### Description - -Please provide a clear and concise description of the bug or issue. - -#### Version - -What version of Overseerr are you running? (You can find this in Settings → About → Version.) - -#### Steps to Reproduce - -Please tell us how we can reproduce the undesired behavior. - -1. Go to [...] -2. Click on [...] -3. Scroll down to [...] -4. See error in [...] - -#### Expected Behavior - -Please provide a clear and concise description of what you expected to happen. - -#### Screenshots - -If applicable, please provide screenshots depicting the problem. - -#### Device - -What device were you using when you encountered this issue? Please provide this information to help us reproduce and investigate the bug. - -- **Platform:** [e.g., desktop, smartphone, tablet] -- **Device:** [e.g., iPhone X, Surface Pro, Samsung Galaxy Tab] -- **OS:** [e.g., iOS 8.1, Windows 10, Android 11] -- **Browser:** [e.g., Chrome, Safari, Edge, Firefox] - -#### Additional Context - -Please provide any additional information that may be relevant or helpful. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index f65cfa76..28248226 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,8 +1,8 @@ blank_issues_enabled: false contact_links: - - name: Support via Discord + - name: 💬 Support via Discord url: https://discord.gg/overseerr - about: Chat with users and devs on support and setup related topics. - - name: Support via GitHub Discussions + about: Chat with other users and the Overseerr dev team + - name: 💬 Support via GitHub Discussions url: https://github.com/sct/overseerr/discussions about: Ask questions and discuss with other community members diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml new file mode 100644 index 00000000..8b4a7b5b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.yml @@ -0,0 +1,37 @@ +name: ✨ Feature Request +description: Suggest an idea +labels: ['type:enhancement', 'awaiting-triage'] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this feature request! + + Please note that we use GitHub issues exclusively for bug reports and feature requests. For support requests, please use our other support channels to get help. + - type: textarea + id: description + attributes: + label: Description + description: Is your feature request related to a problem? If so, please provide a clear and concise description of the problem; e.g., "I'm always frustrated when [...]." + validations: + required: true + - type: input + id: desired-behavior + attributes: + label: Desired Behavior + description: Provide a clear and concise description of what you want to happen. + validations: + required: true + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Provide any additional information or screenshots that may be relevant or helpful. + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/sct/overseerr/blob/develop/CODE_OF_CONDUCT.md) + options: + - label: I agree to follow Overseerr's Code of Conduct + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 29b26fbd..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: 'awaiting-triage, type:enhancement' -assignees: '' ---- - -#### Description - -Is your feature request related to a problem? If so, please provide a clear and concise description of the problem. E.g., "I'm always frustrated when [...]." - -#### Desired Behavior - -Provide a clear and concise description of what you want to happen. - -#### Additional Context - -Provide any additional information or screenshots that may be relevant or helpful. diff --git a/.github/workflows/invalid_template.yml b/.github/workflows/invalid_template.yml deleted file mode 100644 index 24f95d74..00000000 --- a/.github/workflows/invalid_template.yml +++ /dev/null @@ -1,19 +0,0 @@ -name: 'Invalid Template' - -on: - issues: - types: [labeled, unlabeled, reopened] - -jobs: - support: - runs-on: ubuntu-20.04 - steps: - - uses: dessant/support-requests@v2.0.1 - with: - github-token: ${{ github.token }} - support-label: 'invalid:template-incomplete' - issue-comment: > - :wave: @{issue-author}, please follow the template provided. - close-issue: true - lock-issue: true - issue-lock-reason: 'resolved'