Hi! We're really excited that you're interested in contributing! Before submitting your contribution, please read through the following guide.
- Bug fixes and changes discussed in the existing issues are always welcome.
- For new ideas, please open an issue to discuss them before sending a PR.
- Make sure your PR passes
npm testand has appropriate commit messages.
You need to have the main API running before running the probe!
You can run the project by following these steps:
- Clone repository.
npm installnpm run dev
If you run into any errors due to failed scripts, try installing the unbuffer package on your local machine. WSL users will need to do this.
A single command to run everything: npm test
To run a specific linter or a test suite, please see the scripts section of package.json.
Most IDEs have plugins integrating the used linter (eslint), including support for automated fixes on save.