contributing.md

Contributing

Setup

This project uses:watch

• pre-commit to manage git hooks
• mozilla/web-ext to run the local demo extension

Install the global tools:

npm install --global web-ext
brew install pre-commit # Or the equivalent for your OS

Ready the project:

npm install
pre-commit install

Build

To run TypeScript on the library:

npm run watch

To run the linter, with autofix:

npm run fix

Testing

Testing is semi-manual. To run the tests, build the extension with:

npm run demo:watch

Then open it in the browser with:

web-ext run

and then open the console. You might need to refresh the page once.