rofi/.github/CONTRIBUTING.md

80 lines
2.6 KiB
Markdown
Raw Normal View History

2017-05-14 19:06:34 +00:00
When reporting bugs keep in mind that the people working on it do this unpaid,
2018-08-03 09:04:16 +00:00
in their free time and as a hobby. So be polite and helpful. Reports that
2017-05-14 19:06:34 +00:00
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
2018-08-03 09:04:16 +00:00
**The issue tracker is for bugs only.**
This is an attempt to keep the issue tracker clean and searchable.
Questions or discussions about new features belong on
2018-09-02 15:01:41 +00:00
[FORUM](https://reddit.com/r/qtools/),
2018-08-03 09:04:16 +00:00
[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.
It is preferred to have feature requests discussed via
2018-09-02 15:01:41 +00:00
[FORUM](https://reddit.com/r/qtools/) or
2018-08-03 09:04:16 +00:00
[IRC](https://webchat.freenode.net/?channels=#rofi) first.
2019-06-28 08:11:21 +00:00
# Creating a bug report
2018-08-03 09:04:16 +00:00
2019-06-28 08:11:21 +00:00
Before creating a bug report:
2016-02-20 12:04:05 +00:00
* 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.
2017-05-14 19:06:34 +00:00
When adding comments to an issue make sure:
* It is relevant to the issue.
* It contributes to solving the issue.
* Use :+1: :-1: emojis instead of replying 'me too' or 'I also have this.'
Issue high-jacking, e.g. adding a request/issue to an existing issue, is very
disruptive.
Please create a new issue, if it is similar it will be marked duplicate.
2016-02-20 12:04:05 +00:00
2018-08-03 09:04:16 +00:00
# Creating a feature request
2016-08-01 12:40:36 +00:00
2018-08-03 09:04:16 +00:00
Before creating a feature request:
* First check the *next* branch, to see if the feature has already been
implemented.
* Check existing reports, see if it is already requested.
When reporting a feature request include the following information:
* Rofi version. (rofi -v)
* A clear description of the feature you want added.
* A use-case for the feature.
If possible try to explain how you would expect to use feature.
For example, should it be a configuration option or a hot-key.
Requesting a feature is no guarantee it will be added.
2017-05-14 19:06:34 +00:00
**Please do not submit reports related to wayland, see
[here](https://github.com/DaveDavenport/rofi/wiki/Wayland) for more
information.**