Questions about SickRage?
To get your questions answered, please ask on the #sickrage-issues IRC channel on irc.freenode.net
Contributing to SickRage
Getting Involved
There are a number of ways to get involved with the development of SickRage. Even if you've never contributed code to an Open Source project before, we're always looking for help identifying bugs, cleaning up code, writing documentation and testing.
The goal of this guide is to provide the best way to contribute to the official SickRage repository. Please read through the full guide detailing How to Report Bugs.
Discussion
If you think you've found a bug please file it in the bug tracker.
Most of the SickRage development team can be found in the #sickrage-issues IRC channel on irc.freenode.net.
How to Report Bugs
Make sure it is a SickRage bug
Many bugs reported are actually issues with the user mis-understanding of how something works (there are a bit of moving parts to an ideal setup) and most of the time can be fixed by just changing some settings to fit the users needs.
If you are new to SickRage, it is usually a much better idea to ask for help first in the SickRage IRC channel. You will get much quicker support, and you will help avoid tying up the SickRage team with invalid bug reports.
Try the latest version of SickRage
Bugs in old versions of SickRage may have already been fixed. In order to avoid reporting known issues, make sure you are always testing against the latest build/source. Also, we put new code in the develop
branch first before pushing down to the master
branch (which is what the binary builds are built off of).
Tips For Submitting Code
Code
NEVER write your patches to the master branch - it gets messy (I say this from experience!)
ALWAYS USE A "TOPIC" BRANCH! Personally I like the branch-feature_name
format that way its easy to identify the branch and feature at a glance. Also please make note of any issue number in the pull commit so we know what you are solving (it helps with cleaning up the related items later).