CONTRIBUTING.md

Prerequisites

Node.js >= v8 must be installed.

Installation

• Running npm install in the component's root directory will install everything you need for development.

Demo Development Server

• npm start will run a development server with the component's demo app at http://localhost:3000 with hot module reloading.

Running Tests

• npm test will run the tests once.

• npm run test:coverage will run the tests and produce a coverage report in coverage/.

• npm run test:watch will run the tests on every change.

Building

• npm run build will build the component for publishing to npm and also bundle the demo app.

• npm run clean will delete built resources.

Commiting

This repository is "commitizen friendly", so commits should be formated using this tool. Instead of 'git commit' you should run...

• npm run cm you'll be prompted to fill out any required commit fields at commit time.

Check commitizen/cz-cli for more info about this tool.