rofi/.github/CONTRIBUTING.md

38 lines
1.6 KiB
Markdown
Raw Normal View History

2016-02-20 12:04:05 +00:00
# Creating an issue
When reporting bugs keep in mind that the people working on it do this unpaid, in their free time and as a hobby. So be
polite and helpful. Bug reports that demand, contain insults to this or other projects, or have a general unfriendly
tone will be closed without discussion. Everybody has it own way of working; What might be the norm for you, might not
be for others. Therefore be verbose in your description.
2016-02-20 12:04:05 +00:00
Before creating an issue:
* Update to the latest version. Check if problem still exists.
* Check existing bug reports, see if it is already reported.
* Read the documentation. Make sure the behaviour you are seeing is a bug.
When reporting bugs include the following information:
* Rofi version. rofi -v
* Rofi configuration. rofi -help (in a [gist](https://gist.github.com/))
2016-02-20 12:04:05 +00:00
* Steps to reproduce.
* What behaviour you see.
* What behaviour you expect to see.
* A proper title for others to search for.
* Be exact.
The issue tracker is not for:
* Questions.
* Writing complaints.
2017-04-11 07:09:20 +00:00
These topics belong on [FORUM](https://reddit.com/r/qtools//), [IRC](https://webchat.freenode.net/?channels=#rofi),
frequently asked questions will be added to the [F.A.Q](https://github.com/DaveDavenport/rofi/wiki#faq) on the
[wiki](https://github.com/DaveDavenport/rofi/wiki).
Questions filled in on the bug tracker will be marked `question`, locked and closed. If the question is clear, I
normally try to provide an answer.
2016-08-01 12:40:36 +00:00
2017-05-01 06:32:03 +00:00
**Please do not submit reports related to wayland, see [here](https://github.com/DaveDavenport/rofi/wiki/Wayland) for
more information.**