Skip to content

Latest commit

 

History

History
36 lines (23 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

36 lines (23 loc) · 1.59 KB

Contributing

Community contributions are welcome, despite experience level. If you'd like to contribute, please follow these guidelines.

Bug Reports & Feature Requests

If you find a bug or have a feature request, search on the Issues page to check if it's already been added.

  • If there is...

    • 👍 the original post
    • if you have additional details feel free to add a comment
  • If there isn't, feel free to create a new issue

    • if it's a bug report related to responsive design, please indicate what width(s) are impacted

Code Contributions

  1. Fork this repository on GitHub

  2. Clone your forked repository to your local machine

  3. Create a new branch for your feature or bug fix: git checkout -b feature-or-bugfix-branch

  4. Remove or disable the original userscript if installed

  5. Test your changes locally from your forked repository, via @require file:///

    1. Tampermonkey
    2. Violentmonkey
    3. Greasemonkey doesn't support local files
  6. Once finished, make sure to lint: npm run lint

    • Auto-fix: npm run clean
  7. Push your changes to your forked repository

  8. Rebase as needed to ensure your changes are in one (1) commit written in present, imperative tense

  9. Open a pull request to this original repository