boomcatch/CONTRIBUTING.md

A standalone, node.js-based beacon receiver for boomerang.

# Contribution guidelines

* Install/update the dependencies:
  ```sh
  npm install
  ```
* Make sure the code lints:
  ```sh
  npm run lint
  ```
* Make sure all of the tests pass:
  ```sh
  npm test
  ```
* Adhere to the coding conventions that are used elsewhere in the codebase.
* New code must have new unit tests.
* New features or changes to existing features must be documented in the [readme] file.
* Add yourself to the [authors] file.
* Feel free to [open an issue][newissue] first, if the change is one that you think needs some discussion.

[readme]: https://github.com/springernature/boomcatch/blob/master/README.md
[authors]: https://github.com/springernature/boomcatch/blob/master/AUTHORS
[newissue]: https://github.com/springernature/boomcatch/issues/new
[issues]: https://github.com/springernature/boomcatch/issues