moparisthebest/SickRage
1
0
Fork 0
mirror of https://github.com/moparisthebest/SickRage synced 2024-12-13 03:22:22 -05:00
Code Issues Releases Wiki Activity

Changing names, branches, URLs

Browse Source
This commit is contained in:
Nils Vogels 2014-05-10 15:59:12 +02:00
parent 1504472990
commit 3163badb4c
1 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
contributing.md
View File

@ -1,4 +1,4 @@
# Contributing to SickBeard # Contributing to SickRage
1. [Getting Involved](#getting-involved) 1. [Getting Involved](#getting-involved)
2. [How To Report Bugs](#how-to-report-bugs) 2. [How To Report Bugs](#how-to-report-bugs)
@ -8,33 +8,33 @@
## Getting Involved ## Getting Involved
There are a number of ways to get involved with the development of SickBeard. 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. 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 SickBeard repository. Please read through the full guide detailing [How to Report Bugs](#how-to-report-bugs). 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](#how-to-report-bugs).
## Discussion ## Discussion
### Forum and IRC ### Forum and IRC
The SickBeard development team frequently tracks posts on the [SickBeard Forum](http://www.sickbeard.com/forums/). If you have longer posts or questions please feel free to post them there. If you think you've found a bug please [file it in the bug tracker](#how-to-report-bugs). The SickRage development team frequently tracks posts on the [SickRage Forum](http://sickrage.tv/). If you have longer posts or questions please feel free to post them there. If you think you've found a bug please [file it in the bug tracker](#how-to-report-bugs).
Additionally most of the SickBeard development team can be found in the [#sickbeard](http://webchat.freenode.net/?channels=sickbeard) IRC channel on irc.freenode.net. Additionally most of the SickRage development team can be found in the [#sickbeard-tvrage](http://webchat.freenode.net/?channels=sickbeard-tvrage) IRC channel on irc.freenode.net.
## How to Report Bugs ## How to Report Bugs
### Make sure it is a SickBeard bug ### 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. 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 SickBeard, it is usually a much better idea to ask for help first in the [Using SickBeard Forum](http://www.sickbeard.com/forums/) or the [SickBeard IRC channel](http://webchat.freenode.net/?channels=sickbeard). You will get much quicker support, and you will help avoid tying up the SickBeard team with invalid bug reports. If you are new to SickRage, it is usually a much better idea to ask for help first in the [Using SickRage Forum](http://sickrage.tv) or the [SickRage IRC channel](http://webchat.freenode.net/?channels=sickbeard-tvrage). You will get much quicker support, and you will help avoid tying up the SickRage team with invalid bug reports.
[SickBeard Issue Tracker](http://code.google.com/p/sickbeard/issues/list) [SickRage Issue Tracker](https://github.com/echel0n/SickRage/issues)
### Try the latest version of SickBeard ### Try the latest version of SickRage
Bugs in old versions of SickBeard 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 `development` branch first before pushing down to the `master` branch (which is what the binary builds are built off of). 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 `dev` branch first before pushing down to the `master` branch (which is what the binary builds are built off of).
## Tips For Submitting Code ## Tips For Submitting Code
@ -44,16 +44,16 @@ Bugs in old versions of SickBeard may have already been fixed. In order to avoid
**NEVER write your patches to the master branch** - it gets messy (I say this from experience!) **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 forum post / google code issue number in the pull commit so we know what you are solving (it helps with cleaning up the related items later). **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 forum post / issue number in the pull commit so we know what you are solving (it helps with cleaning up the related items later).
Please follow these guidelines before reporting a bug: Please follow these guidelines before reporting a bug:
1. **Update to the latest version** — Check if you can reproduce the issue with the latest version from the `development` branch. 1. **Update to the latest version** — Check if you can reproduce the issue with the latest version from the `dev` branch.
2. **Use the SickBeard Forums search** — check if the issue has already been reported. If it has been, please comment on the existing issue. 2. **Use the SickRage Forums search** — check if the issue has already been reported. If it has been, please comment on the existing issue.
3. **Provide a means to reproduce the problem** — Please provide as much details as possible, e.g. SickBeard log files (obfuscate apikey/passwords), browser and operating system versions, how you started SickBeard, and of course the steps to reproduce the problem. 3. **Provide a means to reproduce the problem** — Please provide as much details as possible, e.g. SickRage log files (obfuscate apikey/passwords), browser and operating system versions, how you started SickRage, and of course the steps to reproduce the problem.
### Feature requests ### Feature requests
@ -68,10 +68,10 @@ Please follow these guidelines before sending a pull request:
1. Update your fork to the latest upstream version. 1. Update your fork to the latest upstream version.
2. Use the `development` branch to base your code off of. 2. Use the `dev` branch to base your code off of.
3. Follow the coding conventions of the original repository. Do not change line endings of the existing file, as this will rewrite the file and loses history. 3. Follow the coding conventions of the original repository. Do not change line endings of the existing file, as this will rewrite the file and loses history.
4. Keep your commits as autonomous as possible, i.e. create a new commit for every single bug fix or feature added. 4. Keep your commits as autonomous as possible, i.e. create a new commit for every single bug fix or feature added.
5. Always add meaningful commit messages. We should not have to guess at what your code is suppose to do. 5. Always add meaningful commit messages. We should not have to guess at what your code is supposed to do.