From b011164f6e30f719c2b95d337b72e92c7d90868b Mon Sep 17 00:00:00 2001 From: bakerboy448 <55419169+bakerboy448@users.noreply.github.com> Date: Tue, 24 Nov 2020 18:26:50 -0600 Subject: [PATCH] update GH Issue Templates [skip ci] also update readme --- .github/ISSUE_TEMPLATE.md | 41 ---------------------------- .github/ISSUE_TEMPLATE/bug_report.md | 25 +++++++++-------- .github/ISSUE_TEMPLATE/config.yml | 8 ++++++ .github/ISSUE_TEMPLATE/custom.md | 7 ----- .github/PULL_REQUEST_TEMPLATE.md | 2 +- README.md | 21 +++++--------- 6 files changed, 30 insertions(+), 74 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/custom.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 2b753fb61..000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,41 +0,0 @@ - - - -## Support / Questions - -Please use https://discord.gg/8Y7rDc9 for support. Support requests or questions will be redirected to discord and the issue will be closed. - - - -## Bug Report - -### System Information/Logs - -**Readarr Version:** - -**Operating System:** - -**.net Framework (Windows) or mono (macOS/Linux) Version:** - -**Link to Log Files (debug or trace):** - -**Browser (for UI bugs):** - -### Additional Information - - - -## Feature Request - -### Description of request and what problem are you looking to solve? - -### Other Information diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 28669a337..3ff0f2698 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,6 +1,9 @@ --- -name: Bug report -about: Create a report to help us improve +name: Bug Report +about: Support Requests will be closed immediately, if you are unsure go to our Reddit or Discord first. Exceptions do not mean you found a bug! +title: '' +labels: bug +assignees: '' --- @@ -20,13 +23,13 @@ A clear and concise description of what you expected to happen. **Screenshots** If applicable, add screenshots to help explain your problem. -**Logs** -Link to debug logs. +**Platform Information (please complete the following information):** + - OS: [e.g. Windows 10 2004 / Ubuntu 20.10] + - Docker: [Yes/No] + - Mono or.NET Core Version: [e.g. Mono 5.8 or .Net Core 3.1.10] (found under System -> Status) + - Browser and Version [e.g. chrome 86.0.4240.198] (Only needed for UI issues) + - Readarr Version [e.g. 0.3.0.430] + - Readarr Branch [e.g. master] -**System info (please complete the following information):** - - Readarr Version: [e.g. 0.3.0.430] - - Operating System [e.g. iOS] - - .net Framework (Windows) or mono (macOS/Linux) Version: [e.g. 4.5 or 5.12] - -**Additional context** -Add any other context about the problem here. +**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/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..ce5c688a9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Support via Discord + url: [https://discord.gg/rkEXY2Rbgn] + about: Chat with users and devs on support and setup related topics. + - name: Support via Reddit + url: https://reddit.com/r/Readarr + about: Discuss and search thru support topics. diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md deleted file mode 100644 index 99bb9a009..000000000 --- a/.github/ISSUE_TEMPLATE/custom.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -name: Custom issue template -about: Describe this issue template's purpose here. - ---- - - diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e0d682009..d8f748ad9 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -6,7 +6,7 @@ A few sentences describing the overall goals of the pull request's commits. #### Todos - [ ] Tests -- [ ] Documentation +- [ ] Wiki Updates #### Issues Fixed or Closed by this PR diff --git a/README.md b/README.md index 5ef9e0284..7305bcb29 100644 --- a/README.md +++ b/README.md @@ -21,9 +21,9 @@ Readarr is a ebook (and maybe eventually magazine/audiobook) collection manager ## Support -[![Discord](https://img.shields.io/badge/discord-chat-7289DA.svg?maxAge=60)](https://discord.gg/WWd5ZGg) +[![Discord](https://img.shields.io/badge/discord-chat-7289DA.svg?maxAge=60)](https://discord.gg/rkEXY2Rbgn) [![GitHub](https://img.shields.io/badge/github-issues-red.svg?maxAge=60)](https://github.com/Readarr/Readarr/issues) -[![GitHub Wiki](https://img.shields.io/badge/github-wiki-181717.svg?maxAge=60)](https://github.com/Readarr/Readarr/wiki) +[![Wiki](https://img.shields.io/badge/github-wiki-181717.svg?maxAge=60)](https://wiki.servarr.com/Readarr) [![Docker Pulls](https://img.shields.io/docker/pulls/hotio/readarr)](https://hub.docker.com/r/hotio/readarr) ## Contributors @@ -34,23 +34,16 @@ This project exists thanks to all the people who contribute. [[Contribute](CONTR Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/readarr#backer)] - - + ## Sponsors Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/readarr#sponsor)] - - - - - - - - - - + + +## Mega Sponsors + ### License