Skip to content

Latest commit

 

History

History
61 lines (47 loc) · 2.13 KB

contributing.md

File metadata and controls

61 lines (47 loc) · 2.13 KB

Contributing

Suggestions and pull requests are highly encouraged! Have a look at the open issues.

Notions

  • You will need to be familiar with npm to build this extension.
  • The extension can be loaded into Chrome or Firefox manually (See notes below)
  • All the latest DOM APIs and JavaScript features are available because the extension only has to work in recent versions of Chrome and Firefox. 🎉

Workflow

First clone:

git clone https://github.com/spookyuser/hacker-reads/
cd hacker-reads
npm install

When working on the extension or checking out branches, use this to have it constantly build your changes:

npm run watch # Listen for file changes and automatically rebuild

Then load or reload it into the browser to see the changes (this does not happen automatically).

Loading into the browser

Once built, load it in the browser of your choice:

Chrome Firefox
  1. Open chrome://extensions;
  2. Check the Developer mode checkbox;
  3. Click on the Load unpacked extension button;
  4. Select the folder hacker-reads/distribution.
  1. Open about:debugging#addons;
  2. Click on the Load Temporary Add-on button;
  3. Select the file hacker-reads/distribution/manifest.json.
Or you can use run this command to have Firefox automatically load and reload it through web-ext run:

npm run start:firefox

Attribution

This document is adapted from refined-github/contributing.md