Skip to content

Commit

Permalink
contributing FAQ err
Browse files Browse the repository at this point in the history
  • Loading branch information
BKSteve committed Mar 8, 2024
1 parent 182a96b commit 0cd7bf5
Show file tree
Hide file tree
Showing 6 changed files with 146 additions and 6 deletions.
138 changes: 138 additions & 0 deletions Contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
### Questions about SickChill?

To get your questions answered, please ask on the [sickchill discord](https://discord.gg/FXre9qkHwE)

# Contributing to SickChill

1. [Getting Involved](#getting-involved)
2. [How To Report Bugs](#how-to-report-bugs)
3. [Tips For Submitting Code](#tips-for-submitting-code)


## Getting Involved

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.

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).

## Discussion

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.


## How to Report Bugs

### Make sure it is a SickChill 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 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.

### Try the latest version of SickChill

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).

### Reporting the issue

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).

## Tips For Submitting Code


### Code

**ALWAYS follow SickChill [Coding Standards](https://github.com/SickChill/sickchill.github.io/wiki/SickChill-Coding-Standards)**

Review regularly as they are subject to change and submissions will not be accepted until they meet our guidelines.

**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).

#### Reporting
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 `develop` branch.

2. **Use the search on SickChill** — 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. SickChill log files (obfuscate apikey/passwords), browser and operating system versions, how you started SickChill, and of course the steps to reproduce the problem.

### Pull requests

[Pull requests](https://help.github.com/articles/using-pull-requests) are welcome and the preferred way of accepting code contributions.

Please follow these guidelines before sending a pull request:

1. Update your fork to the latest upstream version.

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.

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.

5. Always add meaningful commit messages. We should not have to guess at what your code is supposed to do.

6. One pull request per feature. If you want multiple features, send multiple PR's

Please follow this process; it's the best way to get your work included in the project:

- [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork,
and configure the remotes:

```bash
# clone your fork of the repo into the current directory in terminal
git clone [email protected]:<your username>/SickChill.git
# navigate to the newly cloned directory
cd SickChill
# assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/SickChill/SickChill.git
```

- If you cloned a while ago, get the latest changes from upstream:

```bash
# fetch upstream changes
git fetch upstream
# make sure you are on your 'master' branch
git checkout master
# merge upstream changes
git merge upstream/master
```

- Make sure that your develop branch is up to date:

```bash
# Switch to the develop branch
git checkout develop
# Pull down any updates
git pull
```

- Create a new topic branch to contain your feature, change, or fix:

```bash
git checkout -b <topic-branch-name> develop
```

- Commit your changes in logical chunks. or your pull request is unlikely
be merged into the main project. Use git's
[interactive rebase](https://help.github.com/articles/interactive-rebase)
feature to tidy up your commits before making them public.

- Push your topic branch up to your fork:

```bash
git push origin <topic-branch-name>
```

- [Open a Pull Request](https://help.github.com/articles/using-pull-requests) with a
clear title and description.


## Code guidelines

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.
6 changes: 3 additions & 3 deletions FAQ's-and-Fixes.md → FAQs-and-Fixes.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@
- [What is post processing?](#what-is-post-processing)
- [How do the quality settings for a show work?](#how-do-the-quality-settings-for-a-show-work)
- [Newly aired shows are not downloading and set to skipped/ignored?](#newly-aired-shows-are-not-downloading-and-set-to-skippedignored)
- [How to Disable and Remove SickChill autostart (systemctl) ?](#how-to-disable-and-remove-sickchill-from-autostart-systemctl-)
- [How to disable and remove SickChill autostart (_systemctl_) ?](#how-to-disable-and-remove-sickchill-from-autostart)
- [Post-processing shows a negative time](#post-processing-shows-a-negative-time)
- [What is a network time zone warning?](#what-is-a-network-time-zone-warning)
- [Unable to send torrent to synology download station](#unable-to-send-torrent-to-synology-download-station)
- [Timeout when adding a show on Freenas](#timeout-when-adding-a-show-on-freenas)
- [What are Unicode errors?](#what-are-unicode-errors)
- [Why does "Send to trash" option not send the files to the Recycle Bin?](#why-does-send-to-trash-option-not-send-the-files-to-the-recycle-bin)
- [Why does "Send to trash" option not send the files to the Recycle Bin?](#why-does-the-send-to-trash-option-not-send-the-files-to-the-recycle-bin)

## Where are the LOG files located?

Expand Down Expand Up @@ -147,7 +147,7 @@ Previously, when you added a show you had the option for **Default Episode Statu
**Solution**
Edit each show (or mass update) and correct the Default Episode Status to WANTED (You can also change from wanted to another on shows where you don't want new episodes to be downloaded automatically)

## How to disable and remove SickChill from autostart (_systemctl_) ?
## How to disable and remove SickChill from autostart?

This step could be useful **if you plan to remove/reinstall SickChill** and you would like to _"start fresh"_.

Expand Down
1 change: 1 addition & 0 deletions Home.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ These documents are a work-in-progress. If you'd like to contribute, please get
- [Issues / Bug reports](https://discord.com/channels/502612977271439372/1048317980343283733)
- [Discussions](https://discord.com/channels/502612977271439372/502612977803984898)
- [Feature requests](https://discord.com/channels/502612977271439372/1112608105025519697)
- [Contributing](Contributing)
- [Donations](Donations)

---
Expand Down
2 changes: 1 addition & 1 deletion Settings-explained.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Key resource links should you wish to chat or fix something that's gone wrong.
You can manually set a time at witch SickChill updates/refreshes the shows information from the indexers. (air dates etc.) Best to use a time at night when the device is idle.
- `Send to trash for actions:`
This option lets SickChill move the files to a recycle bin instead of the normal permanent delete.
Note: doesn't work on all Operating Systems. [(NSSM / WinService workaround)](FAQ's-and-Fixes#why-does-send-to-trash-option-not-send-the-files-to-the-recycle-bin)
Note: doesn't work on all Operating Systems. [(NSSM / WinService workaround)](FAQs-and-Fixes#why-does-the-send-to-trash-option-not-send-the-files-to-the-recycle-bin)
- `Number of Log files saved:`
Lets you set he number of log files that are stored before deleted.
- `Size of Log files saved:`
Expand Down
2 changes: 1 addition & 1 deletion Show-settings-explained.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ This lets you customize the columns of the seasons. You can add the size columns
- `Preferred Quality:`
Lets you set the quality of the file that SickChill should download. See [Quality Settings](Quality-Settings) for more info.
- `Default Episode Status:`
Lets you set the Default Episode Status. Needs to be set to WANTED if you want new shows to be downloaded.! See [Default Episode Status](FAQ%27s-and-Fixes#newly-aired-shows-are-not-downloading-and-set-to-skippedignored) for more info.
Lets you set the Default Episode Status. Needs to be set to WANTED if you want new shows to be downloaded.! See [Default Episode Status](FAQs-and-Fixes#newly-aired-shows-are-not-downloading-and-set-to-skippedignored) for more info.
- `Info Language:`
Lets you set the default language for the show. Info, descriptions etc. Note, not subtitles.!
- `Subtitles:` Enable or disable the automatic download of subtitles for this show.
Expand Down
3 changes: 2 additions & 1 deletion _Sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@
[Installation/Setup Guides](Installation-&-Configuration-Guides)
[Donations and support](Donations)
[Installation packages](SickChill-installation-packages)
[Contributing](Contributing)
[Developers](Developers)

**Debugging**<br/>
[FAQ's and Fixes](FAQ%27s-and-Fixes)
[FAQ's and Fixes](FAQs-and-Fixes)
[Scene exceptions](Scene-exceptions-and-numbering)

**Settings**<br/>
Expand Down

0 comments on commit 0cd7bf5

Please sign in to comment.