Skip to content
This repository has been archived by the owner on Nov 27, 2023. It is now read-only.

Latest commit

 

History

History
54 lines (36 loc) · 913 Bytes

CONTRIBUTING.md

File metadata and controls

54 lines (36 loc) · 913 Bytes

Contributing

Contributions are always welcome, no matter how large or small. Before contributing, please read the code of conduct.

Developing

TSDI is built for Node 6 and up but we develop using Node 10 and yarn. You can check this with node -v.

Make sure that Yarn is installed with version >= 1.6.0. Installation instructions can be found here: https://yarnpkg.com/en/docs/install.

Setup

$ git clone https://github.com/KnisterPeter/tsdi
$ cd tsdi
$ yarn

Then you can either run:

$ yarn build

to build TSDI once or:

$ yarn build:watch

to have TSDI build itself and incrementally build files on change.

Running linting/tests

You can run lint via:

$ yarn linter

You can run tests via:

$ yarn test

or enable debug output via:

$ DEBUG='tsdi' yarn test