How to contribute

Set up environment

1. Please create a fork
2. Setup your Fork on your local PC (git clone)
3. run npm install in the base directory of your repo (Check out nodejs.org if you're new to Node.js)

Linter and Formatter

This project uses ESLint and prettier to ensure code quality If you're using VSCode just install the extensions dbaeumer.vscode-eslint and esbenp.prettier-vscode.

If you're not use VS Code, you may find a similar extension for your program. If not, you can run it in your terminal:

# Linter:
npm run lint
# or to fix errors
npm run lint:fix
# Formater
npm run format

How to test

How you can test your local changes depends on the browser you are using.

Firefox

1. Open about:debugging
2. Click on This Firefox
3. Click the Load Temporary Add-on button
4. Select any file in your extension's directory (e.g., the manifest.json)
5. If you change a file: Click the "Reload" button

Chrome

1. Open chrome://extensions
2. Enable Developer Mode in the top right
3. Click on "Load unpacked"
4. Open the Base directory
5. If you change a file: Click the "Reload" button

Edge

1. Open edge://extensions/
2. Enable Developer Mode at the bottom of the left sidebar
3. Click on "Load unpacked"
4. Open the Base directory
5. If you change a file: Click the "Reload" button

All changes have to be tested on the common browsers Chrome, Firefox, and Edge.