|
| 1 | +### Questions about SickChill? |
| 2 | + |
| 3 | +To get your questions answered, please ask on the [sickchill discord](https://discord.gg/FXre9qkHwE) |
| 4 | + |
| 5 | +# Contributing to SickChill |
| 6 | + |
| 7 | +1. [Getting Involved](#getting-involved) |
| 8 | +2. [How To Report Bugs](#how-to-report-bugs) |
| 9 | +3. [Tips For Submitting Code](#tips-for-submitting-code) |
| 10 | + |
| 11 | + |
| 12 | +## Getting Involved |
| 13 | + |
| 14 | +There are a number of ways to get involved with the development of SickChill. 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. |
| 15 | + |
| 16 | +The goal of this guide is to provide the best way to contribute to the official SickChill repository. Please read through the full guide detailing [How to Report Bugs](#how-to-report-bugs). |
| 17 | + |
| 18 | +## Discussion |
| 19 | + |
| 20 | +If you think you've found a bug please report it on [discord](https://discord.gg/FXre9qkHwE), where you will find most of the sickchill dev team. |
| 21 | + |
| 22 | + |
| 23 | +## How to Report Bugs |
| 24 | + |
| 25 | +### Make sure it is a SickChill bug |
| 26 | + |
| 27 | +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. |
| 28 | + |
| 29 | +If you are new to SickChill, it is usually a much better idea to ask for help first in the [sickchill discord](https://discord.gg/FXre9qkHwE). You will get much quicker support, and you will help avoid tying up the SickChill team with invalid bug reports. |
| 30 | + |
| 31 | +### Try the latest version of SickChill |
| 32 | + |
| 33 | +Bugs in old versions of SickChill 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). |
| 34 | + |
| 35 | +### Reporting the issue |
| 36 | + |
| 37 | +If the above steps fail and you are sure its a bug, issues are tracked in the [SickChill issue tracker](https://github.com/SickChill/SickChill). |
| 38 | + |
| 39 | +## Tips For Submitting Code |
| 40 | + |
| 41 | + |
| 42 | +### Code |
| 43 | + |
| 44 | +**ALWAYS follow SickChill [Coding Standards](https://github.com/SickChill/sickchill.github.io/wiki/SickChill-Coding-Standards)** |
| 45 | + |
| 46 | +Review regularly as they are subject to change and submissions will not be accepted until they meet our guidelines. |
| 47 | + |
| 48 | +**NEVER write your patches to the master branch** - it gets messy (I say this from experience!) |
| 49 | + |
| 50 | +**ALWAYS USE A "TOPIC" BRANCH!** |
| 51 | + |
| 52 | +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). |
| 53 | + |
| 54 | +#### Reporting |
| 55 | +Please follow these guidelines before reporting a bug: |
| 56 | + |
| 57 | +1. **Update to the latest version** — Check if you can reproduce the issue with the latest version from the `develop` branch. |
| 58 | + |
| 59 | +2. **Use the search on SickChill** — check if the issue has already been reported. If it has been, please comment on the existing issue. |
| 60 | + |
| 61 | +3. **Provide a means to reproduce the problem** — Please provide as much details as possible, e.g. SickChill log files (obfuscate apikey/passwords), browser and operating system versions, how you started SickChill, and of course the steps to reproduce the problem. |
| 62 | + |
| 63 | +### Pull requests |
| 64 | + |
| 65 | +[Pull requests](https://help.github.com/articles/using-pull-requests) are welcome and the preferred way of accepting code contributions. |
| 66 | + |
| 67 | +Please follow these guidelines before sending a pull request: |
| 68 | + |
| 69 | +1. Update your fork to the latest upstream version. |
| 70 | + |
| 71 | +2. Use the `develop` branch to base your code off of. Create a topic-branch for your work. We will not merge your 'dev' branch, or your 'master' branch, only topic branches, coming from dev are merged. |
| 72 | + |
| 73 | +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. |
| 74 | + |
| 75 | +4. Keep your commits as autonomous as possible, i.e. create a new commit for every single bug fix or feature added. |
| 76 | + |
| 77 | +5. Always add meaningful commit messages. We should not have to guess at what your code is supposed to do. |
| 78 | + |
| 79 | +6. One pull request per feature. If you want multiple features, send multiple PR's |
| 80 | + |
| 81 | +Please follow this process; it's the best way to get your work included in the project: |
| 82 | + |
| 83 | +- [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork, |
| 84 | + and configure the remotes: |
| 85 | + |
| 86 | +```bash |
| 87 | + # clone your fork of the repo into the current directory in terminal |
| 88 | + git clone [email protected]: <your username >/SickChill.git |
| 89 | + # navigate to the newly cloned directory |
| 90 | + cd SickChill |
| 91 | + # assign the original repo to a remote called "upstream" |
| 92 | + git remote add upstream https://github.com/SickChill/SickChill.git |
| 93 | + ``` |
| 94 | + |
| 95 | +- If you cloned a while ago, get the latest changes from upstream: |
| 96 | + |
| 97 | + ```bash |
| 98 | + # fetch upstream changes |
| 99 | + git fetch upstream |
| 100 | + # make sure you are on your 'master' branch |
| 101 | + git checkout master |
| 102 | + # merge upstream changes |
| 103 | + git merge upstream/master |
| 104 | + ``` |
| 105 | + |
| 106 | +- Make sure that your develop branch is up to date: |
| 107 | + |
| 108 | + ```bash |
| 109 | + # Switch to the develop branch |
| 110 | + git checkout develop |
| 111 | + # Pull down any updates |
| 112 | + git pull |
| 113 | + ``` |
| 114 | + |
| 115 | +- Create a new topic branch to contain your feature, change, or fix: |
| 116 | + |
| 117 | + ```bash |
| 118 | + git checkout -b <topic-branch-name> develop |
| 119 | + ``` |
| 120 | + |
| 121 | +- Commit your changes in logical chunks. or your pull request is unlikely |
| 122 | + be merged into the main project. Use git's |
| 123 | + [interactive rebase](https://help.github.com/articles/interactive-rebase) |
| 124 | + feature to tidy up your commits before making them public. |
| 125 | + |
| 126 | +- Push your topic branch up to your fork: |
| 127 | + |
| 128 | + ```bash |
| 129 | + git push origin <topic-branch-name> |
| 130 | + ``` |
| 131 | + |
| 132 | +- [Open a Pull Request](https://help.github.com/articles/using-pull-requests) with a |
| 133 | + clear title and description. |
| 134 | + |
| 135 | + |
| 136 | +## Code guidelines |
| 137 | + |
| 138 | +Read and follow the [SickChill Coding Standards](https://github.com/SickChill/sickchill.github.io/wiki/SickChill-Coding-Standards). Review these regularly as they are subject to change and code will not be accepted if it does not adhere to the standards. |
0 commit comments