From 3fb5f65f0889e5bf84338a7fa92680a9ccb135e2 Mon Sep 17 00:00:00 2001 From: bakerboy448 <55419169+bakerboy448@users.noreply.github.com> Date: Thu, 5 Aug 2021 18:16:57 -0500 Subject: [PATCH] Use YML Github templates --- .github/ISSUE_TEMPLATE/bug_report.md | 40 ------------ .github/ISSUE_TEMPLATE/bug_report.yml | 73 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/ISSUE_TEMPLATE/feature_request.md | 20 ------ .github/ISSUE_TEMPLATE/feature_request.yml | 39 ++++++++++++ .github/SUPPORT.md | 6 +- README.md | 6 +- 7 files changed, 119 insertions(+), 67 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index a15b65df0..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -name: Bug Report -about: Support Requests will be closed immediately, if you are not 100% certain this is a bug please go to our Reddit, Discord, Forums, or IRC first. Exceptions do not mean you found a bug! -title: '' -labels: '' -assignees: '' - ---- - -**Describe the bug** - - - -**To Reproduce** - -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** - - -**Screenshots** - - -**Platform Information (please complete the following information):** - - - OS: - - Docker: - - .net Framework (Windows) or mono (macOS/Linux) (System -> Status): - - Browser and Version (Only needed for UI issues): - - Sonarr Version: - - Sonarr Branch: - -**Trace Logs** -Turn on Trace logs under Settings -> General and wait for the bug to occur again. -**Upload the full log file here (or another site (e.g. pastebin) and link it). Issues will be closed if they do not include this!** - - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..24f9bb034 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,73 @@ +name: Bug Report +title: "" +description: 'Support Requests will be closed immediately, if you are not 100% certain this is a bug please go to our Reddit, Discord, Forums, or IRC first. Exceptions do not mean you found a bug!' +labels: ['needs-triage'] +body: +- type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. + options: + - label: I have searched the existing issues + required: true +- type: textarea + attributes: + label: Current Behavior + description: A concise description of what you're experiencing. + validations: + required: true +- type: textarea + attributes: + label: Expected Behavior + description: A concise description of what you expected to happen. + validations: + required: true +- type: textarea + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. In this environment... + 2. With this config... + 3. Run '...' + 4. See error... + validations: + required: false +- type: textarea + attributes: + label: Environment + description: | + examples: + - **OS**: Ubuntu 20.04 + - **Sonarr**: Sonarr 3.0.6.1265 + - **Docker Install**: Yes + - **Using Reverse Proxy**: No + - **Browser**: Firefox 90 (If UI related) + value: | + - OS: + - Sonarr: + - Docker Install: + - Using Reverse Proxy: + - Browser: + render: markdown + validations: + required: true +- type: dropdown + attributes: + label: What branch are you running? + options: + - Main + - Develop + - Other (This issue will be closed) + validations: + required: true +- type: textarea + attributes: + label: Anything else? + description: | + Trace Logs (https://wiki.servarr.com/sonarr/troubleshooting#logging-and-log-files) + Links? References? Anything that will give us more context about the issue you are encountering! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 02bd7c4ec..2fb2fa0a1 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -10,5 +10,5 @@ contact_links: url: https://forums.sonarr.tv/ about: Discuss and search through support topics. - name: Support via IRC - url: http://webchat.freenode.net/?channels=#sonarr + url: https://web.libera.chat/?channels=#sonarr about: Chat with users and devs on support and setup related topics. \ 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 7f7f1de7c..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for Sonarr -title: '' -labels: '' -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** - - -**Describe the solution you'd like** - - -**Describe alternatives you've considered** - - -**Additional context** - \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..27c9b9e5a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,39 @@ +name: Feature Request +title: "" +description: 'Suggest an idea for Sonarr' +labels: ['needs-triage'] +body: +- type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the feature you are requesting. + options: + - label: I have searched the existing issues + required: true +- type: textarea + attributes: + label: Is your feature request related to a problem? Please describe + description: A clear and concise description of what the problem is. + validations: + required: true +- type: textarea + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + validations: + required: true +- type: textarea + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: true +- type: textarea + attributes: + label: Anything else? + description: | + Links? References? Mockups? Anything that will give us more context about the feature you are encountering! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: true diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md index 68abd3188..7adf10efb 100644 --- a/.github/SUPPORT.md +++ b/.github/SUPPORT.md @@ -1,7 +1,7 @@ ## Support -There are a number of frequently asked questions that have been answered in our [FAQ](https://wiki.servarr.com/Sonarr_FAQ) +There are a number of frequently asked questions that have been answered in our [FAQ](https://wiki.servarr.com/sonarr/faq) -The [wiki](https://wiki.servarr.com/Sonarr) contains other information and guides +The [wiki](https://wiki.servarr.com/sonarr) contains other information and guides -Please use one of the support channels: [forums](https://forums.sonarr.tv/), [subreddit](https://www.reddit.com/r/sonarr/), [discord ](https://discord.gg/M6BvZn5), or [IRC ](http://webchat.freenode.net/?channels=#sonarr)for support/questions. \ No newline at end of file +Please use one of the support channels: [forums](https://forums.sonarr.tv/), [subreddit](https://www.reddit.com/r/sonarr/), [discord ](https://discord.gg/M6BvZn5), or [IRC](https://web.libera.chat/?channels=#sonarr)for support/questions. \ No newline at end of file diff --git a/README.md b/README.md index b8f4540ad..fa28c3905 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Sonarr is a PVR for Usenet and BitTorrent users. It can monitor multiple RSS fee ## Getting Started - [Download/Installation](https://sonarr.tv/#downloads-v3) -- [FAQ](https://wiki.servarr.com/Sonarr_FAQ) +- [FAQ](https://wiki.servarr.com/sonarr/faq) - [Wiki](https://wiki.servarr.com/Sonarr) - [(WIP) API Documentation](https://github.com/Sonarr/Sonarr/wiki/API) - [Donate](https://sonarr.tv/donate) @@ -16,9 +16,9 @@ Note: GitHub Issues are for Bugs and Feature Requests Only - [Forums](https://forums.sonarr.tv/) - [Discord](https://discord.gg/M6BvZn5) - [GitHub - Bugs and Feature Requests Only](https://github.com/Sonarr/Sonarr/issues) -- [IRC ](http://webchat.freenode.net/?channels=#sonarr) +- [IRC](https://web.libera.chat/?channels=#sonarr) - [Reddit](https://www.reddit.com/r/sonarr) -- [Wiki](https://wiki.servarr.com/Sonarr) +- [Wiki](https://wiki.servarr.com/sonarr)