diff options
author | Dave Davenport <qball@gmpclient.org> | 2018-08-03 11:04:16 +0200 |
---|---|---|
committer | Dave Davenport <qball@gmpclient.org> | 2018-08-03 11:04:16 +0200 |
commit | 4631ac711f8048433ea9b5a3449179ef3f583cd7 (patch) | |
tree | 16ed76137b8a1e92f7515baf81f2fb50fd7c987a /.github | |
parent | ed3d893610ca135c02e5a58b57a5d52bc1afb0f2 (diff) |
Try to clarify guidelines a bit.
Diffstat (limited to '.github')
-rw-r--r-- | .github/CONTRIBUTING.md | 53 |
1 files changed, 40 insertions, 13 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index adf51bc6..2d9ac2d4 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -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.** |