Skip to content

Latest commit

 

History

History
35 lines (27 loc) · 703 Bytes

CONTRIBUTING.md

File metadata and controls

35 lines (27 loc) · 703 Bytes
Raw

Contributing Guide

Development Setup

Node.js is needed for the development of eruda.

After cloning the repo, run:

# install npm dependencies.
npm install
# copy jasmine lib from node_modules to test folder.
npm run setup

Commonly used NPM scripts

# watch and auto re-build.
npm run dev
# build eruda.js and eruda.min.js
npm run build
# lint, build and test.
npm run ci
# check test coverage.
npm run cov

Project Structure

  • doc: documents.
  • eustia: eustia extended utilties.
  • script: webpack configuration, and some other useful scripts.
  • src: source code, written in es2015.
  • test: contain pages for testing.