Skip to content
This repository has been archived by the owner on Nov 28, 2019. It is now read-only.

Commit

Permalink
Jackett Dark 0.0.1-beta release
Browse files Browse the repository at this point in the history
## v0.0.1-beta ... (16 MAY 19)

### Initial Release
  • Loading branch information
JourneyOver committed May 17, 2019
1 parent 4adad94 commit 28c32fc
Show file tree
Hide file tree
Showing 21 changed files with 1,213 additions and 2 deletions.
21 changes: 21 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# EditorConfig helps developers define and maintain consistent
# coding styles between different editors and IDEs
# editorconfig.org

root = true

[*]
charset = utf-8
end_of_line = crlf
insert_final_newline = true
indent_style = space
indent_size = 2
trim_trailing_whitespace = true

[*.css]
block_comment_start = /*:::
block_comment = *
block_comment_end = :::*/

[*.svg]
insert_final_newline = false
2 changes: 2 additions & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
root: true
extends: eslint-config-silverwind
22 changes: 22 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Auto detect text files and perform LF normalization
* text=auto

# Custom for Visual Studio
*.cs diff=csharp
*.sln merge=union
*.csproj merge=union
*.vbproj merge=union
*.fsproj merge=union
*.dbproj merge=union

# Standard to msysgit
*.doc diff=astextplain
*.DOC diff=astextplain
*.docx diff=astextplain
*.DOCX diff=astextplain
*.dot diff=astextplain
*.DOT diff=astextplain
*.pdf diff=astextplain
*.PDF diff=astextplain
*.rtf diff=astextplain
*.RTF diff=astextplain
119 changes: 119 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
# Contributing to Jackett Dark

- [Contributing to jackett Dark](#contributing-to-jackett-dark)
- [Getting Involved](#getting-involved)
- [How to Report Style issues](#how-to-report-style-issues)
- [I don't know CSS](#i-dont-know-css)
- [I rock at CSS & GitHub!](#i-rock-at-css--github)
- [Style Guide](#style-guide)
- [Getting Started](#getting-started)
- [Build & test](#build--test)
- [Development Scripts](#development-scripts)

## Getting Involved

There are a number of ways to get involved with the development of this theme. Even if you've never contributed to an Open Source project before, we're always looking for help identifying missing styles or other issues.

## How to Report Style issues

### I don't know CSS

If you don't know CSS very well and have found a missing style, please include as much as possible of following information when opening an issue:

- Screenshot of the problem; include the element(s) in the console if at all possible
- To select an element, target it with your mouse then right-click and choose "Inspect Element"
- Please include both the HTML view and the element with the problem in the screenshot
- A URL to the page (if public).

### I rock at CSS & GitHub!

- Follow the style guide below
- Make any needed changes, then send us a pull request
- Please include a URL to the page (if public)

## Style Guide

- Use the provided `.editorconfig` file with your code editor. Don't know what that is? Then check out <http://editorconfig.org/>.
- Limit to the [K&R (KNF variation style)](https://en.wikipedia.org/wiki/Indentation_style#Variant:_BSD_KNF), and **2 SPACE INDENTATION** (no tabs, and not more, and not less than 2 spaces).

- K&R - KNF Variation Example:

```css
element[attr='value'] {
··property: value;
}
```

- **Not Allman**

```css
element[property='value']
{
··property: value;
}
```

- Strict space between the `selector` and the `{`:

```css
/* good */
element[attr='value'] { }

/* bad */
element[attr='value']{ }
```

- 2 Space indentation

```css
/* good */
··property: value;

/* bad */
····property: value;
----property: value;
·property: value;
```

- Try to wrap lines at around 80 characters.
- Try to limit the style size:
- Don't add any image URI's to the css; instead add the image into the `/images` directory; then point to using the following URL: `https://raw.githubusercontent.com/StylusThemes/Jackett-Dark/master/images/`{my-image.png}.
- If possible, reduce any added selectors. Remember that Stylus requires an `!important` flag to override default styling, so a selector starting from the body isn't always necessary.
- Don't add any inline comments. If you want to make a comment, add it as a note in the commit.
- If your css definition already exists within the style, do not add it again! Add your selector to the existing definition.
- Insert any new css selectors in the available slot immediately before the style definition, or on a new line as needed.
- If you want to add a new userstyle or usercss variable, please open an issue and discuss it with us first.

## Getting Started

- [Download](https://github.com/StylusThemes/Jackett-Dark/archive/master.zip), [fork](https://github.com/StylusThemes/Jackett-Dark/fork) or clone this repository.
- Use [node.js](http://nodejs.org/) to run `npm install`.
- Make any changes
- In `style.css` for common styles.
- In `/optionals` for different options.

### Build & test

- Create & change into a new branch of your local Jackett-Dark repository.
- Open the style in the Stylus editor, and make sure to have "live preview" checked for testing.
- Once you are satisfied with the changes, select all the css (<kbd>Ctrl</kbd> + <kbd>a</kbd>), copy (<kbd>Ctrl</kbd> + <kbd>c</kbd>) then paste (<kbd>Ctrl</kbd> + <kbd>v</kbd>) it into your editor.
- Run `npm run test` to test the css changes.
- Now you can add and commit the changes to your fork's branch.
- If you haven't already contributed, then run `npm run authors` to add your name to our list of contributors :smile:
- Push the changes to your branch, then submit a pull request.
- And thanks again for contributing!

### Development Scripts

- `npm run authors`: Runs a batch file to rebuild the `AUTHORS` file.
- `npm run clean`: Runs the perfectionist script & cleans up after it.
- `npm run eslint`: Lint the JavaScript code in the `tools` directory.
- `npm run lint`: Run eslint & stylelint scripts.
- `npm run major`: Creates a semantic major release.
- `npm run minor`: Creates a semantic minor release.
- `npm run patch`: Creates a semantic patch release.
- `npm run perfectionist`: Runs perfectionist only. CSS is not cleaned!
- `npm run stylelint`: Run stylelint on the css file.
- `npm run test`: Same as `npm run lint`.
- `npm run update`: Update development dependencies.
- `npm run usercss`: Update usercss variables using usercss template; variable data obtained from `defaults.json`.
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<!--
Thank you for reporting an issue. Please make sure that your style is up to
date and you checked the recent commits that your issue wasn't recently
addressed. To update:
Make sure to first update DIRECTLY from our repository, then force refresh
the web page (Windows: Ctrl+F5; Mac/Apple: Apple+R or Command+R; Linux: F5).
If the issue persists, please help us identifying the cause by providing these
details:
-->

- **Browser**:
- **Operating System**:
- **Screenshot**:
- **URL of where this happens**:

- **HTML of the section where the issue occurs**:

<!-- You can get the HTML by right click on the element, look for the
highlighted node in the DevTools, right click it and select
Copy -> Outer HTML -->

```html

```
23 changes: 23 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# lockfiles
package-lock.json
yarn.lock

# temp stuff
tmp/
*.tmp
.bak_files/


# logs
*.stackdump
*.log

# Build
node_modules/

# Windows crap
Thumbs.db
Desktop.ini

# Mac crap
.DS_Store
1 change: 1 addition & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
package-lock=false
46 changes: 46 additions & 0 deletions .stylelintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
{
"extends": "stylelint-config-standard",
"ignoreFiles": ["*.user.css", "*/*.user.css", "*.min.css"],
"rules": {
"at-rule-empty-line-before": null,
"block-no-empty": null,
"block-opening-brace-space-before": "always",
"color-hex-case": null,
"color-named": "never",
"color-no-invalid-hex": true,
"comment-empty-line-before": null,
"comment-no-empty": null,
"comment-whitespace-inside": null,
"declaration-bang-space-before": "always",
"declaration-block-no-duplicate-properties": null,
"declaration-block-single-line-max-declarations": null,
"declaration-colon-newline-after": null,
"declaration-empty-line-before": null,
"declaration-no-important": null,
"font-family-name-quotes": "always-where-recommended",
"font-family-no-duplicate-names": true,
"function-url-quotes": "always",
"indentation": null,
"max-empty-lines": 1,
"no-descending-specificity": null,
"no-duplicate-selectors": true,
"number-leading-zero": "never",
"number-max-precision": 3,
"number-no-trailing-zeros": true,
"rule-empty-line-before": [
"always-multi-line",
{
"except": ["after-single-line-comment", "first-nested"],
"ignore": ["after-comment", "inside-block"],
"severity": "warning"
}
],
"selector-combinator-space-after": "always",
"selector-combinator-space-before": "always",
"selector-list-comma-newline-after": null,
"selector-pseudo-element-colon-notation": "double",
"selector-type-no-unknown": null,
"string-quotes": "double",
"value-list-comma-newline-after": null
}
}
5 changes: 5 additions & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Authors ordered by first contribution.

Journey <timtag1190@gmail.com>

# Generated by tools/authors.sh
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Jackett Dark Changelog

## v0.0.1-beta ... (16 MAY 19)

### Initial Release
Loading

0 comments on commit 28c32fc

Please sign in to comment.