Skip to content

Latest commit

 

History

History
45 lines (28 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

45 lines (28 loc) · 1.73 KB
Raw

Contributing

We are open to, and grateful for, any contributions made by the community. By contributing, you agree to abide by the code of conduct.

Code Style

Please follow the prettier and eslint styles configured in the source code.

Testing

Please update the tests to reflect your code changes. Pull requests will not be accepted if they are failing on GitHub CI.

Documentation

Please update the docs accordingly so that there are no discrepencies between the API and the documentation.

Developing

VSCode

  • Install NPM packages Installs NPM packages, should be run whenever the branch changes (due to switch or pull)
  • Start watch for changes and restart the server (on http://localhost:3000/)
  • Build Runs the build & lint scripts
  • Lint es Runs eslint
  • Run tests Runs all tests - requires Dev to be running
  • Watch tests watch for changes and run all tests - requires Dev to be running

Command line

  • npm start Start the examples server, also used in integration tests
  • npm run test run all unit tests (requires the server to be started)
  • npm run test:watch watch for changes and run all unit tests

Releasing

Releases are automatically deployed to NPM when a github release is made. Go to Github releases and either create a new release or publish the draft release created by the release-drafter Github bot. Versions should follow semantic versioning.

Running Examples

Examples are included in part to allow manual testing.

$ npm start
# Open 127.0.0.1:3000