From 880fbc242db18e46b1cf9c4e66f863cfd8103e88 Mon Sep 17 00:00:00 2001
From: patrick96
Date: Mon, 7 Mar 2022 21:35:30 +0100
Subject: [PATCH] Expand support page
---
.github/ISSUE_TEMPLATE/bug_report.yml | 2 +-
SUPPORT.md | 31 +++++++++++++++++++++------
2 files changed, 26 insertions(+), 7 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index d16f16dc..8f9fadf4 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -33,7 +33,7 @@ body:
id: config
attributes:
label: Minimal config
- description: A minimal but complete config with which the problem occurs.
+ description: A minimal but **complete** config with which the problem occurs.
render: dosini
placeholder: |
[bar/example]
diff --git a/SUPPORT.md b/SUPPORT.md
index e3db08cd..77bfe048 100644
--- a/SUPPORT.md
+++ b/SUPPORT.md
@@ -1,5 +1,4 @@
-Getting Help
-============
+# Getting Help
If you need help or troubleshooting tips or just have a question:
@@ -7,9 +6,29 @@ If you need help or troubleshooting tips or just have a question:
* Read the [Known Issues page](https://github.com/polybar/polybar/wiki/Known-Issues), maybe others had the same issue before.
* Read the [Wiki page](https://github.com/polybar/polybar/wiki) for the thing you have problems with.
* Ask your question on [GitHub Discussions](https://github.com/polybar/polybar/discussions)
-* Join our Gitter room at [gitter.im/polybar/polybar](https://gitter.im/polybar/polybar)
-* Ask in our reddit community at [r/polybar](https://www.reddit.com/r/polybar)
-* Join the official IRC channel `#polybar` on the [`irc.libera.chat:6697`](https://libera.chat/) network. If you don't get an answer try asking on [Gitter](https://gitter.im/polybar/polybar).
+* Join our Gitter room at [`gitter.im/polybar/polybar`](https://gitter.im/polybar/polybar)
+* Ask in our reddit community at [`r/polybar`](https://www.reddit.com/r/polybar)
+* Join the official IRC channel `#polybar` on the [`irc.libera.chat:6697`](https://libera.chat/) network. This is IRC, you will need to be connected to receive answers.
* Ask on [Unix & Linux StackExchange](https://unix.stackexchange.com/). Though not all questions may be suited over there, make sure you're [on topic](https://unix.stackexchange.com/help/on-topic).
-Please **do not** use the github issue tracker to ask for help or if you have a question, it is meant for bug reports and feature requests. Issues will be closed and you will be referred to the above resources.
+**Do not** use the GitHub issue tracker to ask for help or if you have questions, it is meant for bug reports.
+Issues will be closed and you will be referred to the above resources.
+
+## Asking Quality Questions
+
+Spending some time to precisely frame your question will save a lot of time.
+You will better understand your problem and may be able to solve it yourself
+and other will be able to better understand what you are asking.
+Here are some tips:
+
+* Be explicit and precise:
+ * What are you trying to achieve?
+ * What problems have you encountered while trying to achieve this?
+ * What is stopping you from overcoming these problems?
+* If a problem is difficult to describe, screenshots can help. Do not make
+ screenshots of your config file or error messages, copy-paste them as text.
+* Provide as much context as possible. In most cases this includes at least the following:
+ * Window Manager
+ * Polybar version
+ * Relevant portions of your config file. If you are not sure what is relevant, provide the whole thing.
+ * How you start polybar