Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (25 loc) · 867 Bytes

CONTRIBUTING.md

File metadata and controls

40 lines (25 loc) · 867 Bytes

Contributing

Development

Requirements: Latest Node.js (including npm)

Before you start developing, you should clone or download this repository and run:

$ npm install

To start the API server for development run:

$ npm start

The development server will automatically restart the server on file changes.

After you have done something check your syntax with running:

$ npm run linting

Also check if you've set the JSDOC comments correctly by running:

$ npm run doc

and opening ./build/doc.

Contribution and License Agreement

If you contribute to this project, you are implicitly allowing your code to be distributed under this license. You are also implicitly verifying that all code is your original work.