Skip to content

Latest commit

 

History

History
81 lines (62 loc) · 3.51 KB

CONTRIBUTING.md

File metadata and controls

81 lines (62 loc) · 3.51 KB
Raw

Contributing to GitHub Upstream BugFixes

  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 GitHub Upstream BugFixes theme for Stylus. Even if you've never contributed to an Open Source project before, we're always looking for help identifying missing issues.

How to Report 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 the 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)
  • 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)

GitHub Upstream BugFixes 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 at all possible, use "npm run clean" to do the wrapping for you.

    • If possible, reduce any added selectors. Remember that !important flag to override default styling should be used only if necessary.
    • Do add inline comments. Comments help ID the issues and convey messages for other users/devs, however add it as a note in the commit message body.
    • 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.
  • Use node.js to run npm install.
  • Make any changes to the github-upstream-bugfixes.user.css file and save.