Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (24 loc) · 1.49 KB

CONTRIBUTING.md

File metadata and controls

30 lines (24 loc) · 1.49 KB
Raw

How to Contribute

  1. Fork this repo, run npm install
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'useful commit message')
  4. Push to the branch (git push origin my-new-feature)
  5. Start a Pull Request

Always run npm run build before pushing changes to a PR. This ensure the public folder is up to date with the latest extension code.

Project Structure

  • public - Contains the Extension files.
  • src - Contains the Svelte src files.
  • public/build - Contains JS/CSS files generated by Svelte Compiler

src

The three root level files are in src, called NewTab.svelte, Popup.svelte and Options.svelte. You can map the components on the screen by going down from the root level files.

Setting Up for Development

  1. Clone the repository to your local machine
  2. Enable 'Developer Mode' on your Chrome(ium) browser at 'chrome://extensions/'
  3. Select 'Load unpacked' button and point it to the public folder
  4. Experiment

Running Scripts

  • npm run build - builds all the extension files to public folder.
  • npm run dev-newtab - Watches and rebuilds the new tab page to public folder on changes
  • npm run dev-popup - Watches and rebuilds the popup section to public folder on changes
  • npm run dev-options - Watches and rebuilds the options page to public folder on changes
  • npm run dev-all - Watches and rebuilds the complete extension to public folder on changes (Will be slower).