Skip to content
This repository was archived by the owner on Jul 16, 2019. It is now read-only.

Latest commit

 

History

History
25 lines (16 loc) · 949 Bytes

CONTRIBUTING.md

File metadata and controls

25 lines (16 loc) · 949 Bytes

Contributing guide

Overview

This guide should give a developer all information to start contributing to the codebase

Technical Information

JS ES6

  • all latest features from es6 are allowed to use, and we compile our library with BabelJS

Server Communication

  • we use xhr library to make our http requests
  • we are using the default implementation of WebSocket

Package npm scripts

  • npm run build-publish - exports babel compiled code to publish folder (enable import drawr from 'drawr')
  • npm run commit-test - check code style and syntax, runs unit tests and builds library
  • npm run export - exports library to dist/drawr.js and dist/drawr.min.js
  • npm start
    • --test - starts unit tests server
  • npm test - runs unit tests