Rooba
/
polybar
mirror of https://github.com/polybar/polybar.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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.
This commit is contained in:
patrick96 2018-10-27 14:56:48 +02:00 committed by Patrick Ziegler
parent 914ec3e102
commit 07913058fb
3 changed files with 18 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.github/ISSUE_TEMPLATE/bug_report.md vendored
View File

@ -1,6 +1,6 @@
---
name: Bug or Issue Report
about: Create a report to help us improve
name: Bug Report
about: Create a report for something that misbehaves
---

10
README.md
View File

@ -25,15 +25,16 @@ Here are a few screenshots showing you what it can look like:
You can find polybar configs for these example images (and other configs) [here](https://github.com/jaagr/dots/tree/master/.local/etc/themer/themes).
If you need help, check out the [Support](SUPPORT.md) page.
**If you need help**, check out the [Support](SUPPORT.md) page.
Please report any issues or bugs you may find by [creating an issue ticket](https://github.com/jaagr/polybar/issues/new/choose) here on GitHub.
Make sure you include steps on how to reproduce it. There's also an irc channel available at freenode, cleverly named `#polybar`.
Please report any bugs you find by [creating an issue ticket](https://github.com/jaagr/polybar/issues/new/choose) here on GitHub.
Make sure you include steps on how to reproduce it.
## Table of Contents
* [Introduction](#introduction)
* [Getting Help](#getting-help)
* [Getting started](#getting-started)
* [Dependencies](#dependencies)
* [Building from source](#building-from-source)
@ -69,6 +70,9 @@ Some of the services included so far:
[See the wiki for more details](https://github.com/jaagr/polybar/wiki).
## Getting Help
If you find yourself stuck, have a look at our [Support](SUPPORT.md) page for resources where you can find help.
## Getting started

14
SUPPORT.md
View File

@ -1,8 +1,12 @@
Polybar Support
===============
Getting Help
============
Reading [Polybar Wiki](https://github.com/jaagr/polybar/wiki) should help you with most of the problems you encounter when using polybar. It has a page for each module, describing what it does and what configuration options it provides.
If you need help or troubleshooting tips or just have a question:
If you can't find the information you are looking for on the wiki, look through the existing [issues](https://github.com/jaagr/polybar/issues?q=is%3Aissue), to see if anyone had the same problem before.
* Read the [Known Issues page](https://github.com/jaagr/polybar/wiki/Known-Issues), maybe others had the same issue before.
* Read the [Wiki page](https://github.com/jaagr/polybar/wiki) for the thing you have problems with.
* Ask in our reddit community at [/r/polybar](https://www.reddit.com/r/polybar)
* Join the official IRC channel `#polybar` on the `chat.freenode.net` network. Make sure to let your IRC client be connected long enough to get an answer, if you disconnect after 15 minutes, you will likely not get any response.
* 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).
If you are still not able to resolve your problem, go ahead and open a new issue and also document what you have done up to that point to solve the problem.
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.