Skip to content

Latest commit

聽

History

History
79 lines (61 loc) 路 3.33 KB

CONTRIBUTING.md

File metadata and controls

79 lines (61 loc) 路 3.33 KB
Raw

Contributing to Overlay Scrollbars

  1. Getting Involved
  2. How To Report style issues
  3. Core Style Guide
  4. Getting Started

Getting Involved

There are a number of ways to get involved with the development of this Overlay Scrollbars theme for Stylish. 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 (see issue #119 for an example)

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)

Overlay Scrollbars 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), and 2 SPACE INDENTATION (no tabs, and not more, and not less than 2 spaces).

    • K&R - KNF Variation Example:

      element[attr='value'] {
路路property: value;
}

    • Not Allman

      element[property='value']
{
路路property: value;
}

    • Strict space between the selector and the {:

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

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

    • 2 Space indentation

      /* good */
路路property: value;

/* bad */
路路路路property: value;
----property: value;
路property: value;

  • Try to wrap lines at around 80 characters.

    • 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 any available slot before the style definition, or on a new line as needed.

  • If you want to add a new userstyle variable, please open an issue and discuss it with us first.

  • Don't include version bumps with your contribution, all releases are handled internally.

  • If your PR fixes an open issue or replaces another PR, include fixes/closes #issue-nr in your commit message title. Read more on this.

Getting Started

  • Download, fork or clone this repository.
  • Make any changes to the overlay-scrollbars.user.css file and save. Thank you for your contribution!