Contributing

We love pull requests. Here's a quick guide:

Fork the repo.
Run the tests. We only take pull requests with passing tests, and it's great to know that you have a clean state.
Add a test for your change. Only refactoring and documentation changes require no new tests. If you are adding functionality or fixing a bug, we need a test!
Make the test pass.
Push to your fork and submit a pull request.

Run Tests

Speedo uses the Jest testrunner to run its unit tests. In order to run them call:

$ npm test

If you want to check your test coverage and see which lines are not yet covered, just use a simple static server to serve the coverage report:

$ npm i -g http-server
$ cd coverage/lcov-report/
$ http-server -p 8080

You can find the coverage report when opening localhost:8080 in the browser.

Open the GitHub Workflow package to running releases
Click on Run workflow drop down button
Enter a release type (patch, minor or major) - please follow semver semantics