Skip to content

Latest commit

 

History

History
54 lines (34 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

54 lines (34 loc) · 1.87 KB
Raw

Thanks for your interest in contributing! If anything in here is unclear or outdated, please update it too 😄

Development setup

  1. Fork this repo
  2. Run yarn install in the project directory

Chrome

  1. Open the Chrome extension settings
  2. Click Load unpacked and select this project

Firefox

  1. Open the tempory extension settings
  2. Click Load temporary add-on and select the manifest.json for this project

You should now be able to use the extension as described in the README. You'll need to click the refresh button on the extension settings to reload the extension after code changes.

Testing locally

You can run the tests with

yarn test

We use Jest. To update the snapshots after making changes, you can run

yarn test -u

Don't forget to review the updates and make sure only intended changes are included!

Pull Requests

  • Document any change in behaviour. Make sure the README and any other relevant documentation are kept up-to-date.
  • Create topic branches. Don't ask us to pull from your master branch.
  • One pull request per feature. If you want to do more than one thing, send multiple pull requests.
  • Send coherent history. Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before sending them to us.

How to release (Admin-only)

Only needed for user-facing changes!

  1. Bump the version in manifest.json and get changes merged to master
  2. Create a .zip (rm app.zip && zip -j app app/*)
  3. Upload it to the Chrome and Firefox stores

Notes:

  • It can take a while for the changes to be reflected in the browser addon stores.
  • Your browser will automatically update the extension when ready, there's no need to re-download manually from the store.