CONTRIBUTING.md

Contributing

Development contribution guide (work-in-progress).

Contents

• Contents
• Developing
  • Workflows
  • Installing
  • Running
  • Enabling Developer Extensions
    • Chrome
    • Firefox
  • Linting
• Creating Features

Developing

Workflows

To run the extension in development:

1. Clone the repository
2. Install and run
3. Enable development extensions in Chrome or Firefox

Installing

1. Fork the repository

2. Clone the fork locally and navigate to the containing folder

3. Install dependencies:

   npm install

4. Install the stylus package globally:

   npm install -g stylus

Running

To run the development server in watch mode:

npm run watch

Enabling Developer Extensions

Chrome

In order to access the development build in Chrome, you must enable developer extensions.

1. Open Chrome
2. Navigate to chrome://extensions/ (More Tools > Extensions)
3. Enable Developer mode in the top-right corner
4. Click Load unpacked
5. Select the dist folder of the project directory

Firefox

In order to access the development build in Firefox, you can either run it on the command-line via web-ext or load it as a temporary add-on.

To run via command-line (with automatic reloading when files change):

1. Install web-ext globally:

   npm install -g web-ext

2. Make sure the development build is running (in watch mode)

3. Navigate into the dist directory, and run web-ext:

   web-ext run

This will open a browser with the add-on loaded.

To load as a temporary add-on:

1. Open Firefox
2. Navigate to about:debugging
3. Click Enable add-on debugging
4. Click Load Temporary Add-on and select the manifest.json file in the dist directory

Linting

To run all linting:

npm run lint

To automatically fix linting errors:

npm run lint-fix

Creating Features

To create new features, please take a look at the format of any feature file found here.

Proper documentation for contributing is a work in progress. Thanks for the patience! 🙂