Skip to content

Developer Guide

Matthias Frener edited this page Dec 23, 2020 · 12 revisions

Developer Guide

Prerequisites:

Build commands

  • Build the library code to /dist folder npm run build

  • Build ESLint on the library code. npm run lint

  • Run the library code. npm test

  • Create development (internal) documentation to /doc-dev folder npm run doc:dev

  • Create public API documentation to /doc folder npm run doc

  • Build a full release. This includes running tests, building /dist folder and creating API documentation. npm run release

Rules

  • When you change code or add new code, make sure npm run lint outputs 0 errors and 0 warnings.
  • Before your push changes, run npm run release to verify build works, all tests succeed and documentation is updated.
Clone this wiki locally