mirror of
https://github.com/davatorium/rofi.git
synced 2025-02-10 15:44:41 -05:00
Try to clarify guidelines a bit.
This commit is contained in:
parent
ed3d893610
commit
4631ac711f
1 changed files with 40 additions and 13 deletions
53
.github/CONTRIBUTING.md
vendored
53
.github/CONTRIBUTING.md
vendored
|
@ -1,13 +1,31 @@
|
|||
# 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
|
||||
in their free time and as a hobby. So be polite and helpful. 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.
|
||||
|
||||
Before creating an issue:
|
||||
|
||||
**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
|
||||
[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.
|
||||
|
||||
It is preferred to have feature requests discussed via
|
||||
[FORUM](https://reddit.com/r/qtools//) or
|
||||
[IRC](https://webchat.freenode.net/?channels=#rofi) first.
|
||||
|
||||
# Creating an bug report
|
||||
|
||||
Before creating an bug report:
|
||||
|
||||
* Update to the latest version. Check if problem still exists.
|
||||
* Check existing bug reports, see if it is already reported.
|
||||
|
@ -34,19 +52,28 @@ 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.
|
||||
|
||||
The issue tracker is not for:
|
||||
|
||||
* Questions.
|
||||
* Writing complaints.
|
||||
|
||||
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).
|
||||
# Creating a feature request
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
**Please do not submit reports related to wayland, see
|
||||
[here](https://github.com/DaveDavenport/rofi/wiki/Wayland) for more
|
||||
information.**
|
||||
|
|
Loading…
Add table
Reference in a new issue