Skip to content

Latest commit

 

History

History
41 lines (23 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

41 lines (23 loc) · 1.64 KB

Contributing

This doc is about code contributions. For other ways to help, see README.

Development setup

Usually it goes like this:

1. Set up the environment

Follow the steps in README.md#build, until the yarn build part.

2. Build (for development)

If you're gonna be testing your changes in a Chromium-based browser, run yarn serve:chromium. For Gecko-based browsers it's yarn serve:gecko. The built files will appear in ./dist-chromium (or ./dist-gecko), and will update as you make changes to the code.

3. Load the extension into the browser

Follow these instructions:

Now it should be working, like you just installed it from a store.

Don't forget to click the "reload extension" button in the browser after you make changes in order for them to take effect. For content scripts, also reload the page you're testing it on.

4. Debug

You can open browser dev tools for each script (background, popup, content) of the extension:

Closing points

I encourage you to be bold when making changes.

And as always, reach out to me if you have any problems!