Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (30 loc) · 1.21 KB

CONTRIBUTING.md

File metadata and controls

42 lines (30 loc) · 1.21 KB

Contributions

Contributions are welcome and are greatly appreciated! Every little bit helps, and credit will always be given.

Development Setup

  1. Install node using version stated in .nvmrc. If nvm is installed, run nvm use from the root of the repository to set node to the correct version.
  2. Install npm packages with npm i
  3. Building:
    • npm run watch -- local: Does a build and watch to the /dist folder at root.
    • local is a set of environment variables located at scripts/envs/local.sh which configure the build. Add your own environment files or adjust this one to make any adjustments needed.
  4. Viewing the build in Chrome:
    1. Navigate to chrome://extensions in Chrome.
    2. Select "Developer Mode" in the top right.
    3. Click "Load unpacked" button and navigate to the dist folder generated by Step 2.

Report Bugs

Report bugs via the Github Issue Tracker.

Please report relevant information and preferably code that exhibits the problem.

Fix Bugs

Look through the github issues for bugs. Anything is open to whoever wants to implement it.

Static code checks

Linting rules will be arriving shortly.