Skip to content

Latest commit

 

History

History
19 lines (13 loc) · 634 Bytes

CONTRIBUTING.md

File metadata and controls

19 lines (13 loc) · 634 Bytes
Raw

Contributing

PRs are welcomed! To get started developing:

  1. Install Node.js and NPM
  2. Install dependencies with npm install
  3. Run npm start to run the server
  4. Run npm test to run tests with Jest

You can run FILL_DEMO=true npm run test -- 'test/demo.test.ts' to populate sample data into your locally running server.

Releases

Versions follow the semantic versioning spec.

To release:

  1. Use npm version <major | minor | patch> to bump the version
  2. Run git push --follow-tags to push with tags

GitHub actions will then pick it up and handle the actual publishing to the NPM registry.