polybar/SUPPORT.md

# Getting Help

If you need help or troubleshooting tips or just have a question:

* If applicable, go through our [debugging guide](https://github.com/polybar/polybar/wiki/Debugging-your-Config).
* 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. 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).

**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
Expand support page 2022-03-07 15:35:30 -05:00			`# Getting Help`
Add SUPPORT.md (#803) Adding this file to the root of the project will make a note appear when opening a new issue, asking the user to first read this document. As proposed in #802 2017-10-28 17:17:46 -04:00
Clearly separate issue and bug reports The issue tracker should be for bugs only. Right now actual bugs can easily fall through the cracks because we get stuck answering questions and basically providing tech support. This move is also intended to have more traffic to our subreddit and IRC channel with the hope that the community can also help itself out. 2018-10-27 08:56:48 -04:00			`If you need help or troubleshooting tips or just have a question:`
Add SUPPORT.md (#803) Adding this file to the root of the project will make a note appear when opening a new issue, asking the user to first read this document. As proposed in #802 2017-10-28 17:17:46 -04:00
Add debugging guide to SUPPORT.md 2020-11-26 14:16:39 -05:00			`* If applicable, go through our [debugging guide](https://github.com/polybar/polybar/wiki/Debugging-your-Config).`
migration: Update URLs jaagr/polybar -> polybar/polybar Travis changed their url for new projects to travis-ci.com 2019-05-06 07:51:49 -04:00			`* 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.`
Update markdown files to point to discussions 2022-03-07 14:53:55 -05:00			`* Ask your question on [GitHub Discussions](https://github.com/polybar/polybar/discussions)`
Expand support page 2022-03-07 15:35:30 -05:00			* 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.
Clearly separate issue and bug reports The issue tracker should be for bugs only. Right now actual bugs can easily fall through the cracks because we get stuck answering questions and basically providing tech support. This move is also intended to have more traffic to our subreddit and IRC channel with the hope that the community can also help itself out. 2018-10-27 08:56:48 -04:00			`* 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).`
Add SUPPORT.md (#803) Adding this file to the root of the project will make a note appear when opening a new issue, asking the user to first read this document. As proposed in #802 2017-10-28 17:17:46 -04:00
Expand support page 2022-03-07 15:35:30 -05:00			`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`