From c4f554cb2004c82507b825151cdc38563e15f8d3 Mon Sep 17 00:00:00 2001 From: Jamie Howarth Date: Fri, 10 Dec 2021 23:47:30 +0000 Subject: [PATCH] Added some quick instructions for contributors to compile & test locally --- CONTRIBUTING.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..5c31e86 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,19 @@ +# CONTRIBUTING + +## Prerequisites + +* Node.js +* Typescript (`npm i -g typescript`) + +## Compiling + +* Run `tsc` in the `extension` directory, or `tsc --watch` for auto-compilation when you make changes to the codebase + +## Testing + +These instructions are for Chromium-based browsers only (Chrome, Edge, Brave, Vivaldi, etc.), instructions for Firefox would be appreciated. Make sure to hawe compiled your code first. If using live reloading using `--watch`, you will *still* have to manually reload the extension in the Extensions window for any changes to be picked up by the browser. + +* Open [chrome://extensions](chrome://extensions) +* Enable "Developer mode" +* Click "load unpacked" +* Select the `extension` directory