Skip to content

Commit

Permalink
Plex Fixes 1.2.0 release
Browse files Browse the repository at this point in the history
## v1.2.0 ... (28 FEBRUARY 19)

### Changes:
`+` Reverted `Rewrote theme into LESS style.` due to the fact that I wanted to bring back the `Port Number & Custom Url options`.
`+` Changed how I build the style.
  • Loading branch information
JourneyOver committed Feb 28, 2019
1 parent a350bbf commit 23fc7b7
Show file tree
Hide file tree
Showing 28 changed files with 905 additions and 948 deletions.
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
160 changes: 98 additions & 62 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,83 +1,119 @@
# Contributing to Plex-Fixes

1. [Getting Involved](#getting-involved)
2. [How To Report style issues](#how-to-report-style-issues)
3. [Core Style Guide](#style-guide)
4. [Getting Started](#getting-started)
- [Contributing to Plex-Fixes](#contributing-to-plex-fixes)
- [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, I'm always looking for help identifying missing styles or other issues.
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).
- 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 a pull request
* Please include a url to the page (if public)
- 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 Style](https://en.wikipedia.org/wiki/Indentation_style#K.26R), and **2 SPACE INDENTATION** (no tabs, and not more, and not less than 2 spaces).

* K&R 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/Plex-Fixes/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 me first.
- 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/Plex-Fixes/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, fork or clone this repository.
* It's easiest to try out your changes within the Stylus editor.
* The live preview option (available soon) will make it easy to see your style changes as you make them.
* Once done, make the same changes to the `Style.css` file in the repo and save. It might be easiest to copy & paste the entire style from the Stylus editor.
- [Download](https://github.com/StylusThemes/Plex-Fixes/archive/master.zip), [fork](https://github.com/StylusThemes/Plex-Fixes/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 Plex-Fixes 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`.
7 changes: 5 additions & 2 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
<!--
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.
addressed. To update:
If the issue persists, please help me identifying the cause by providing these
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:
-->

Expand Down
1 change: 1 addition & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
package-lock=false
6 changes: 6 additions & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Authors ordered by first contribution.

Journey <[email protected]>
The Codacy Badger <[email protected]>

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

## v1.2.0 ... (28 FEBRUARY 19)

### Changes:
`+` Reverted `Rewrote theme into LESS style.` due to the fact that I wanted to bring back the `Port Number & Custom Url options`.
`+` Changed how I build the style.

## v1.1.1 ... (21 FEBRUARY 19)

### Additions:
Expand Down
16 changes: 0 additions & 16 deletions build/build.js

This file was deleted.

56 changes: 0 additions & 56 deletions build/files.js

This file was deleted.

Loading

0 comments on commit 23fc7b7

Please sign in to comment.