supersonic/Midora
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added some quick instructions for contributors to compile & test locally

Browse Source
This commit is contained in:
Jamie Howarth 2021-12-10 23:47:30 +00:00
parent 911fc4a0f0
commit c4f554cb20
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
CONTRIBUTING.md Normal file
View File

@ -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