Skip to content

Commit a39ba79

Browse files
miigotumiigotu
authored
Merge pull request #21 from SickChill/python3
Update for python3.6+, add workflows
2 parents 74b2200 + 3e34223 commit a39ba79

35 files changed

+592
-710
lines changed

‎.github/CONTRIBUTING.md‎

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
### Questions about SickChill?
2+
3+
To get your questions answered, please ask on the [#sickchill](http://webchat.freenode.net/?channels=sickchill) IRC channel on irc.freenode.net
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 [file it in the bug tracker](#how-to-report-bugs).
21+
22+
Most of the SickChill development team can be found in the [#sickchill](http://webchat.freenode.net/?channels=sickchill) IRC channel on irc.freenode.net.
23+
24+
25+
## How to Report Bugs
26+
27+
### Make sure it is a SickChill bug
28+
29+
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.
30+
31+
If you are new to SickChill, it is usually a much better idea to ask for help first in the [SickChill IRC channel](http://webchat.freenode.net/?channels=sickchill). You will get much quicker support, and you will help avoid tying up the SickChill team with invalid bug reports.
32+
33+
### Try the latest version of SickChill
34+
35+
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).
36+
37+
### Reporting the issue
38+
39+
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).
40+
41+
## Tips For Submitting Code
42+
43+
44+
### Code
45+
46+
**ALWAYS follow SickChill [Coding Standards](https://github.com/SickChill/sickchill.github.io/wiki/SickChill-Coding-Standards)**
47+
48+
Review regularly as they are subject to change and submissions will not be accepted until they meet our guidelines.
49+
50+
**NEVER write your patches to the master branch** - it gets messy (I say this from experience!)
51+
52+
**ALWAYS USE A "TOPIC" BRANCH!**
53+
54+
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).
55+
56+
#### Reporting
57+
Please follow these guidelines before reporting a bug:
58+
59+
1. **Update to the latest version** — Check if you can reproduce the issue with the latest version from the `develop` branch.
60+
61+
2. **Use the search on SickChill** — check if the issue has already been reported. If it has been, please comment on the existing issue.
62+
63+
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.
64+
65+
### Pull requests
66+
67+
[Pull requests](https://help.github.com/articles/using-pull-requests) are welcome and the preferred way of accepting code contributions.
68+
69+
Please follow these guidelines before sending a pull request:
70+
71+
1. Update your fork to the latest upstream version.
72+
73+
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.
74+
75+
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.
76+
77+
4. Keep your commits as autonomous as possible, i.e. create a new commit for every single bug fix or feature added.
78+
79+
5. Always add meaningful commit messages. We should not have to guess at what your code is supposed to do.
80+
81+
6. One pull request per feature. If you want multiple features, send multiple PR's
82+
83+
Please follow this process; it's the best way to get your work included in the project:
84+
85+
- [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork,
86+
and configure the remotes:
87+
88+
```bash
89+
# clone your fork of the repo into the current directory in terminal
90+
git clone git@github.com:<your username>/SickChill.git
91+
# navigate to the newly cloned directory
92+
cd SickChill
93+
# assign the original repo to a remote called "upstream"
94+
git remote add upstream https://github.com/SickChill/SickChill.git
95+
```
96+
97+
- If you cloned a while ago, get the latest changes from upstream:
98+
99+
```bash
100+
# fetch upstream changes
101+
git fetch upstream
102+
# make sure you are on your 'master' branch
103+
git checkout master
104+
# merge upstream changes
105+
git merge upstream/master
106+
```
107+
108+
- Make sure that your develop branch is up to date:
109+
110+
```bash
111+
# Switch to the develop branch
112+
git checkout develop
113+
# Pull down any updates
114+
git pull
115+
```
116+
117+
- Create a new topic branch to contain your feature, change, or fix:
118+
119+
```bash
120+
git checkout -b <topic-branch-name> develop
121+
```
122+
123+
- Commit your changes in logical chunks. or your pull request is unlikely
124+
be merged into the main project. Use git's
125+
[interactive rebase](https://help.github.com/articles/interactive-rebase)
126+
feature to tidy up your commits before making them public.
127+
128+
- Push your topic branch up to your fork:
129+
130+
```bash
131+
git push origin <topic-branch-name>
132+
```
133+
134+
- [Open a Pull Request](https://help.github.com/articles/using-pull-requests) with a
135+
clear title and description.
136+
137+
138+
## Code guidelines
139+
140+
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.

‎.github/FUNDING.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# These are supported funding model platforms
2+
3+
github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
4+
patreon: SickChill
5+
open_collective: # Replace with a single Open Collective username
6+
ko_fi: # Replace with a single Ko-fi username
7+
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8+
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9+
liberapay: # Replace with a single Liberapay username
10+
issuehunt: # Replace with a single IssueHunt username
11+
otechie: # Replace with a single Otechie username
12+
custom: ['https://github.com/SickChill/SickChill/wiki/Donations']

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
### Before submitting your issue:
2+
Branch/Commit:
3+
OS:
4+
Browser:
5+
What you did:
6+
What happened:
7+
What you expected:
8+
Logs:
9+
```
10+
PASTE LOGS HERE
11+
```

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Fixes #
2+
3+
Proposed changes in this pull request:
4+
-
5+
-
6+
-
7+
8+
- [ ] PR is based on the DEVELOP branch
9+
- [ ] Don't send big changes all at once. Split up big PRs into multiple smaller PRs that are easier to manage and review
10+
- [ ] Read [contribution guide](https://github.com/SickChill/SickChill/blob/master/.github/CONTRIBUTING.md)

‎.github/issue_label_bot.yaml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
label-alias:
2+
bug: 'Bug / Issue'
3+
feature_request: 'Feature Request'
4+
question: 'Question'

‎.github/stale.yml‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Configuration for probot-stale - https://github.com/probot/stale
2+
3+
# Number of days of inactivity before an Issue or Pull Request becomes stale
4+
daysUntilStale: 60
5+
6+
# Number of days of inactivity before an Issue or Pull Request with the stale label is closed.
7+
# Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale.
8+
daysUntilClose: 7
9+
10+
# Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable
11+
exemptLabels:
12+
- Confirmed
13+
- "Bug / Issue"
14+
- Pinned
15+
- Security
16+
- "[Status] Maybe Later"
17+
- "Feature Request"
18+
- "In Progress"
19+
- "Enhancement"
20+
21+
# Set to true to ignore issues in a project (defaults to false)
22+
exemptProjects: false
23+
24+
# Set to true to ignore issues in a milestone (defaults to false)
25+
exemptMilestones: false
26+
27+
# Label to use when marking as stale
28+
staleLabel: Stale
29+
30+
# Comment to post when marking as stale. Set to `false` to disable
31+
markComment: >
32+
This issue has been automatically marked as stale because it has not had activity in 60 days.
33+
It will be closed in 7 days if no further activity occurs. Thank you for your contributions.
34+
35+
# Comment to post when removing the stale label.
36+
unmarkComment: >
37+
This issue has now been unmarked as "stale"
38+
39+
# Comment to post when closing a stale Issue or Pull Request.
40+
closeComment: >
41+
This issue has been closed due to inactivity in the last 67 days.
42+
43+
# Limit the number of actions per hour, from 1-30. Default is 30
44+
limitPerRun: 30
45+
46+
# Limit to only `issues` or `pulls`
47+
# only: issues
48+
49+
# Optionally, specify configuration settings that are specific to just 'issues' or 'pulls':
50+
# pulls:
51+
# daysUntilStale: 30
52+
# markComment: >
53+
# This pull request has been automatically marked as stale because it has not had
54+
# recent activity. It will be closed if no further activity occurs. Thank you
55+
# for your contributions.

‎.github/workflows/build.yaml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# This workflow will build the package and make a release
2+
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
3+
4+
name: Build & Release
5+
6+
on: push
7+
8+
jobs:
9+
build:
10+
name: Build
11+
strategy:
12+
matrix:
13+
os: [ubuntu-20.04]
14+
fail-fast: true
15+
runs-on: ${{ matrix.os }}
16+
steps:
17+
- name: Cancel Previous Runs
18+
uses: styfle/cancel-workflow-action@0.8.0
19+
with:
20+
access_token: ${{ github.token }}
21+
- name: Checkout
22+
uses: actions/checkout@v2
23+
with:
24+
fetch-depth: 1
25+
persist-credentials: false
26+
path: readynas-sickchill
27+
- name: Build Debian package
28+
run: |
29+
cd readynas-sickchill
30+
sudo apt-get -qq update
31+
sudo apt-get install -y debhelper dh-autoreconf devscripts
32+
debuild -i -us -uc -b
33+
mkdir ../artifacts
34+
mv ../sickchill_20* ../artifacts/
35+
echo 'Done'
36+
- name: Release
37+
if: startsWith(github.ref, 'refs/tags/')
38+
uses: fnkr/github-action-ghr@v1
39+
env:
40+
GHR_PATH: artifacts
41+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.github/workflows/greetings.yml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Greetings
2+
3+
on:
4+
pull_request:
5+
types:
6+
opened
7+
issues:
8+
types:
9+
opened
10+
11+
jobs:
12+
greeting:
13+
runs-on: ubuntu-latest
14+
if: github.repository == 'SickChill/readynas-sickchill'
15+
steps:
16+
- uses: actions/first-interaction@v1
17+
with:
18+
repo-token: ${{ secrets.GITHUB_TOKEN }}
19+
issue-message: 'Hi, thanks for the report. Please use search to make sure your issue has not been reported yet, and someone will try to help you as soon as possible.'
20+
pr-message: 'Thanks for your PR, it is most appreciated. Please make sure your PR is targeting the develop branch. We will get it reviewed as soon as possible.'

‎.gitignore‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,76 @@
11

22
git-files/
3+
/git-files/
4+
debian/sickchill
5+
6+
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
7+
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
8+
9+
# User-specific stuff
10+
.idea/**/workspace.xml
11+
.idea/**/tasks.xml
12+
.idea/**/usage.statistics.xml
13+
.idea/**/dictionaries
14+
.idea/**/shelf
15+
16+
# Generated files
17+
.idea/**/contentModel.xml
18+
19+
# Sensitive or high-churn files
20+
.idea/**/dataSources/
21+
.idea/**/dataSources.ids
22+
.idea/**/dataSources.local.xml
23+
.idea/**/sqlDataSources.xml
24+
.idea/**/dynamic.xml
25+
.idea/**/uiDesigner.xml
26+
.idea/**/dbnavigator.xml
27+
28+
# Gradle
29+
.idea/**/gradle.xml
30+
.idea/**/libraries
31+
32+
# Gradle and Maven with auto-import
33+
# When using Gradle or Maven with auto-import, you should exclude module files,
34+
# since they will be recreated, and may cause churn. Uncomment if using
35+
# auto-import.
36+
# .idea/artifacts
37+
# .idea/compiler.xml
38+
# .idea/jarRepositories.xml
39+
# .idea/modules.xml
40+
# .idea/*.iml
41+
# .idea/modules
42+
# *.iml
43+
# *.ipr
44+
45+
# CMake
46+
cmake-build-*/
47+
48+
# Mongo Explorer plugin
49+
.idea/**/mongoSettings.xml
50+
51+
# File-based project format
52+
*.iws
53+
54+
# IntelliJ
55+
out/
56+
57+
# mpeltonen/sbt-idea plugin
58+
.idea_modules/
59+
60+
# JIRA plugin
61+
atlassian-ide-plugin.xml
62+
63+
# Cursive Clojure plugin
64+
.idea/replstate.xml
65+
66+
# Crashlytics plugin (for Android Studio and IntelliJ)
67+
com_crashlytics_export_strings.xml
68+
crashlytics.properties
69+
crashlytics-build.properties
70+
fabric.properties
71+
72+
# Editor-based Rest Client
73+
.idea/httpRequests
74+
75+
# Android studio 3.1+ serialized cache file
76+
.idea/caches/build_file_checksums.ser

‎.idea/.gitignore‎

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)