diff options
| author | Leon Bubova <bubova.leon@gmx.de> | 2021-12-15 02:57:06 +0300 |
|---|---|---|
| committer | Leon Bubova <bubova.leon@gmx.de> | 2021-12-15 12:14:19 +0300 |
| commit | 64fb3595d22876a3dc3c09436eb4073f67be8a51 (patch) | |
| tree | 4fb98bcc48728ae3e77b31fee459b15c9abb1235 /CONTRIBUTING.md | |
| parent | 7b9c1781b40f70a1e056eef4cb953141df331ada (diff) | |
add doc to Get Started on how to create bundled source files
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 607bb00..1a41707 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,6 +4,35 @@ Thank you for investing your time in contributing to our project! All your chang ## Getting Started Please use Prettier with default settings for formatting. + +#### Prerequisites + +You need to have node and npm installed to create the bundled version of the source. + +Versions used when setting up: + +- node: 12.18.4 +- npm: 6.14.6 + +To create the `bundled-content-script.js` that contains most of the business logic of this extension you have to install all dependencies first. + +1. Go to the root of the repo and run: + +``` +npm install +``` + +2. Run the following command to create `bundled-content-script.js` which is used in `manifest.json` + +``` +npm run bundle +``` + +This will also start a watcher that re-bundles automatically once you save a file inside the source. + +Congratulations, You are now ready to develop! + + ### Issues #### Opening a new issue If you have any issues with the extension, please search to make sure the issue isn't already reported. If it isn't, open an issue, using the issue form is highly recommended but not mandatory. |