l.behm/bumblebee-status
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Create CONTRIBUTING.md

Browse source
This commit is contained in:
tobi-wan-kenobi 2017-06-15 13:08:14 +02:00 committed by GitHub
parent f25b04ee28
commit 302e14007b
1 changed files with 17 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,17 @@
Most importantly: Many thanks for considering contributing to bumblebee-status! I am continuously amazed by the quality and creativity of the Pull Requests I get - many thanks!
One thing I need to mention: This is a project I am working on in my (limited) spare time. I try very hard to answer bug tickets and review Pull Requests as quickly as possible, but it might take days, in some cases even weeks, until I get around to doing so. I want to give every contribution the attention it deserves. Really: I am not ignoring you, I'm simply slow :-)
### Filing a Bug
If you want to file a bug, simply open an issue and describe your problem. Things that help narrow down the problem are:
* Steps to reproduce
* Relevant section of the i3 configuration
* Debug logs and console output of bumblebee-status
But even if you can't provide those, any indicator that something is not working as it should is much appreciated!
### Adding a new Module or Theme
If you want to add a new module, please have a look at [How to write a new module](https://github.com/tobi-wan-kenobi/bumblebee-status/wiki/How-to-write-a-module) and [How to write a new theme](https://github.com/tobi-wan-kenobi/bumblebee-status/wiki/How-to-write-a-theme). Then simply create a Pull Request and I will review the changes as soon as possible.
If you want to do me a *big* favour, check the Travis status for any failing unit tests. Oh - and if you happen to add unit tests, that's also something I am very grateful for!
Thanks for reading until here! :)