Skip to content

Latest commit

 

History

History
29 lines (17 loc) · 878 Bytes

CONTRIBUTING.md

File metadata and controls

29 lines (17 loc) · 878 Bytes

Prerequisites

Installation

  • Run yarn in the module's root directory to install everything you need for development.
  • Run yarn build in the root directory to build the modules.

Running Tests

  • yarn test will run the tests once.

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

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

Building

  • Run yarn build in the root directory to build the modules. (Required before publishing)
  • yarn clean will delete built resources.

Documentation Website Development

  • Run above installation steps and then
  • Run yarn start:site to run a development server of gatsby.
  • Run yarn build:site to create a build of the assets for the documentation website.