contributor.md

Installation guide

Clone the project :

$ git clone https://github.com/DWTechs/Slughorn.js.git

Launch with docker

build image :

$ cd Slughorn/
$ docker-compose up -d

build lib :

$ cd Slughorn/
$ docker-compose run slughorn

OR

Install project dependencies :

$ cd Slughorn/
$ npm i

Workflow

• create a branch following these instructions

• build the library :

  $ npm run build

• test the library :

  $ npm run test

• commit your work following conventional commits rules :

Folders

• scripts/
• dist/
• src/
• tests/
• web/