Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

39 lines (28 loc) · 1.33 KB

Contributing to my Userscripts repo

How to Report Issues, Or Make Requests.

When reporting problems:

  • Start the issue title having the related script title in parenthesis.
  • Be as specific as possible, I need to know where to look.
  • State name and version of your browser and script manager.
  • Provide a web address example where I can see the problem for myself. A domain name is not enough.
  • Provide a screenshot if necessary.

When making feature requests:

  • Be as specific as possible, don't make me have to guess what you want.

Contributing Code

Installation:

Just use a script manager, such as Tampermonkey, Greasemonkey or Violentmonkey

Pull Requests:

You are welcome to open pull requests as long as you:

  • Follow the style that is already being used in the code, see the repo's .eslintrc rules
  • When naming variables:
    • Use names that properly describe the contents of the variable.
    • Use camel casing as needed.
  • Use comments if necesary.
  • Use semicolons.
  • Use single quotes.
  • Use tabs, not 4 spaces indentation.
  • Try not to have too long lines.