Skip to content

Latest commit

 

History

History
33 lines (21 loc) · 1 KB

CONTRIBUTING.md

File metadata and controls

33 lines (21 loc) · 1 KB
Raw

Installation

  • Run npm install
  • Run npm run build
  • Run npm link

Usage

Run Izyum [options]

Available commands

Formatting

This project uses prettier tool for code formatting, so just run command npm run format before you want to commit something

In order to make prettier work properly with vs code on save, make sure to install the esbenp.prettier-vscode plugin

Linting

Project uses eslint and has the config for it use following command to run it: npm run format before you want to commit something

Testing

Izyum uses jest for unit testing and has following npm commands for this purposes

  • npm test - runs unit tests
  • npm run test:watch - runs unit tests in a watch mode
  • npm run coverage - shows testing coverage