Contributing

Prerequisites

You need NodeJS installed in order to contribute to this project.

Instead of installing NodeJS, you can use docker and put these scripts in your $PATH :

#!/bin/bash
# npm
docker run \
    --rm \
    -it \
    -u $(id -u):$(id -g) \
    -v "$(pwd)":/app \
    --workdir /app \
    node \
    npm $@

#!/bin/bash
# node
docker run \
    --rm \
    -u $(id -u):$(id -g) \
    -v "$(pwd)":/app \
    --workdir /app \
    node \
    node $@

npm i;

npm run test;

npm run cover;

npm run lint;

Before committing any piece of code, make sure you added/modified the corresponding tests.

Some pre-commit hooks are here to make sure that :