Contributing

Contributing Guide

Style Guide

We use eslint to style our project. Make sure you have it setup, and set to use our eslint settings (they are in the project root).

Run the following to test the library formatting

npm run lint

Testing

To test the library, run the following:

npm run lint && NODE_DEBUG=themeparks npm run test

This will run the code format check, and then run the unit tests (with NODE_DEBUG set, so we get debug output).

No code should be committed until this succeeds! All pull requests will be automatically tested against this command.

Documenting

** TODO **

To rebuild the HTML docs, run:

npm run docs