Table of Contents

1. Development Setup
2. Contribution Guidelines

Development Setup

Prerequisites

• Node.js (^12.0.0)

Install all the necessary dependencies:

# with yarn (recommended)
$ yarn install

# with npm
$ npm install

Start the development server:

$ yarn dev

# or

$ npm run dev

You may see all the available scripts here.

Contribution Guidelines

In order to contribute to this project, more specifically to this package, you have to follow a few guidelines.

1. English Only

Everything, from variables and comments to commit messages and pull requests should be in and only in english, no exceptions.

2. Prettier & ESLint

These tools are here for a reason - don't use eslint-disable unless when extremely necessary. I'm also talking about you, @ts-ignore.

3. Typescript

Although allowJs is set to true for compatibility reasons, all new code - including tests - should be written in Typescript. Take advantage of types and interfaces - don't use any and unknown.

4. Documentation

All code should, except tests, be documented using JSDoc. Of course types don't need to - and shouldn't - be described in JSDoc since we are using TS.

5. Tests

When submitting pull requests, be sure to provide unit tests for all the new features and that old tests are still passing. The coverage should be at least 80%.