From 27d257ce1d95d9267e0bf00a022130e97c118f21 Mon Sep 17 00:00:00 2001 From: Helium314 Date: Sat, 28 Sep 2024 22:28:25 +0200 Subject: [PATCH] udpate templates --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- .github/ISSUE_TEMPLATE/other.md | 2 +- README.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 261f74d4..fdec74bd 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -24,7 +24,7 @@ If possible, provide all the necessary steps to reproduce your problem, includin If it's not obvious (e.g. not crash), describe how you think the app should behave. **Screenshots** -ONLY add screenshots if applicable and helpful. +ONLY add screenshots when they add real value. If you add screenshots, reduce the size or use thumbnails to keep the issue nicely readable. **App version** diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index e3fd107e..9a488a4b 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -8,7 +8,7 @@ Please see the appropriate readme section for issue reporting guidelines: https: tl;dr: * search for duplicates, also in closed issues * a single issue per topic -* reduce screenshot size +* ONLY add screenshots when necessary, and reduce their size diff --git a/README.md b/README.md index bbb7d3a9..e8c89a17 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,7 @@ Before opening a new issue, be sure to check the following: - **Is the issue still relevant?** Make sure your issue is not already fixed in the latest version of HeliBoard. - **Is it a single topic?** If you want to suggest multiple things, open multiple issues. - **Did you use the issue template?** It is important to make life of our kind contributors easier by avoiding issues that miss key information to their resolution. -Note that issues that that ignore part of the issue template will likely get treated with very low priority, as often they are needlessly hard to read or understand (e.g. huge screenshots, not providing a proper description, or addressing multiple topics). +Note that issues that that ignore part of the issue template will likely get treated with very low priority, as often they are needlessly hard to read or understand (e.g. huge screenshots, not providing a proper description, or addressing multiple topics). Blatant violation of the guidelines may result in the issue getting closed. If you're interested, you can read the following useful text about effective bug reporting (a bit longer read): https://www.chiark.greenend.org.uk/~sgtatham/bugs.html