Skip to content

Latest commit

 

History

History
37 lines (21 loc) · 2.05 KB

CONTRIBUTING.md

File metadata and controls

37 lines (21 loc) · 2.05 KB

Contributing

Anyone can contribute to this repo, so long as you don't break anything on purpose.

Bug reporting

Please report any errors you're having with one of the scripts. This will help you and others and make the script better.

When reporting an issue include the script name in the title and follow the template below for it's description:

Script: {name} {version}
Browser: {name} {version}
Addon (e.g. Tampermonkey): {name} {version}
Error Message: {message}
Screenshot: {drag&drop}
Description: {description}

Or click here to open a new issue.

Bug fixes

If you find any sort of error, spelling mistake, etc. in this project, feel free to fix it and submit a pull request with your commit. Little fixes like this are welcomed and are usually accepted pretty quickly.

Feature requests

Time is limited, so feature requests are discussed and released when possible and time permits. You can always send a pull request to speed up the process.

Code style

Many conventions are available for writing code, but in this repo there's only one correct and that's mine 😊

Please use the following conventions:

  • Obey to linting (ESLint) rules. You can run them via npm run lint.
  • Install EditorConfig to help.
  • Follow the conventions you see used in the source already.

Git Commit Messages

  • Use the past tense ("Added feature" not "Add feature").
  • Limit the first line to 72 characters or less.
  • Reference issues and pull requests liberally.