Skip to content

Latest commit

 

History

History
28 lines (20 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

28 lines (20 loc) · 1.39 KB
Raw

Contributing

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

Project setup

To have a working dev environment you have to:

  1. Use Firefox Dev Edition
  2. Visit url about:debugging
  3. Load temporary Addon
  4. Navigate your filesystem and select the manifest file in the addon
  5. The addon is loaded in the toolbar
  6. This project uses prettier for code formatting, kindly run this formatter before pushing any changes
    • To run the formatter, install the prettier extension and set it as default formatter
    • Now use manual format document with option or turn on format on save option to automatically format files when saved
    • Alternatively, install prettier cli (instructions here) and use command prettier --write src to format files with single command

Licence

Your work is under the project licence GPLv3.

Help needed

  1. search for already opened issues: there is chance problem you are trying to solve is already solved
  2. if is releated to extension development: please try to search on internet for a solution first
  3. if is related to resting: open an issue and ask for help. You have to wait, so be patient and try to give all information you can find on your problem and how to replicated it