From d646a37bdbabf0f7933dd178baf895c37a1bb1f5 Mon Sep 17 00:00:00 2001 From: Tomas Slusny Date: Sat, 21 Jul 2018 18:33:47 +0200 Subject: [PATCH] Follow GitHub templates for bug report and issue (#4205) Based on points made in #4160, update GitHub issue templates to be more versatile, do not include any inline comments and be straightforward, while pointing out reporter in correct direction. Also, one of the crucial things that previous template for bug report was missing was RuneLite and Launcher versions and steps to reproduce the bug. Supersedes #4160 Signed-off-by: Tomas Slusny --- .github/ISSUE_TEMPLATE/Bug_report.md | 49 ++++++++++------------- .github/ISSUE_TEMPLATE/Custom.md | 10 ----- .github/ISSUE_TEMPLATE/Feature_request.md | 10 +++-- 3 files changed, 28 insertions(+), 41 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/Custom.md diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md index b769863b7c..219706327f 100644 --- a/.github/ISSUE_TEMPLATE/Bug_report.md +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -1,37 +1,32 @@ --- -name: "\U0001F41BBug report" -about: "If something isn't working as expected \U0001F914." +name: "\U0001F41B Bug report" +about: Create a report to help us improve --- -Please check if your issue is not a duplicate by [searching existing issues](https://github.com/runelite/runelite/issues) -| Question | Answer -| ------------| --------------- -| Java Version | x.y.z -| Operating System | e.g. Ubuntu/Windows/MacOS +Please check if your issue is not a duplicate by [searching existing issues](https://github.com/runelite/runelite/search?type=Issues) +**Describe the bug** +A clear and concise description of what the bug is. - +**Environment (please complete the following information):** + - OS: [e.g. Windows, Ubuntu, macOS] + - RuneLite version: [e.g 1.4.6] + - Launcher version: [e.g 1.5.2] - -
- stack trace - - ``` - %paste your stack trace here% - ``` -
+**Additional context** +Add any other context about the problem here, e.g. logs. Your client logs can usually be found in +`C:\Users\\.runelite\logs` on Windows and `~/.runelite/logs` on Linux and macOS. diff --git a/.github/ISSUE_TEMPLATE/Custom.md b/.github/ISSUE_TEMPLATE/Custom.md deleted file mode 100644 index d6dab2b143..0000000000 --- a/.github/ISSUE_TEMPLATE/Custom.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: "\U0001F917 Support Question" -about: "If you have a question \U0001F4AC, please check out our Discord" - ---- - ---------------^ Click "Preview" for a nicer view! -We primarily use GitHub as an issue & suggestion tracker; for usage and support questions, please check join our Discord: https://discord.gg/mePCs8U - ---- diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md index 8c72f90386..57cf66a8dd 100644 --- a/.github/ISSUE_TEMPLATE/Feature_request.md +++ b/.github/ISSUE_TEMPLATE/Feature_request.md @@ -1,17 +1,19 @@ --- -name: "\U0001F680 Feature Request or RFC" -about: "I have a suggestion (and may want to implement it \U0001F642)!" +name: "\U0001F680 Feature Request" +about: Suggest an idea for this project --- **Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +A clear and concise description of what the problem is. Ex. I'm always +frustrated when [...] **Describe the solution you'd like** A clear and concise description of what you want to happen. **Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. +A clear and concise description of any alternative solutions or features you've +considered. **Additional context** Add any other context or screenshots about the feature request here.