CONTRIBUTING.md

Contributing / Developing

Contributions are welcome. Fork this repository and issue a pull request with your changes.

Please add new tests for new functionality, adapt the existing ones if needed, and make sure that npm test succeeds.

Prerequisites

You need to have Git and npm installed on your system.

Setting up Dev

You'll need to clone the repository and install the required packages. Just execute these commands:

git clone https://github.com/secure-rm/core.git
cd ./secure-rm/
npm install

Building

npm run build

If you want to start compilation in watch mode:

npm run watch-ts

Versioning

We use SemVer for versioning. For the versions available, see the link to tags on this repository.

Tests

This project uses the framework Jest. Jest is a delightful JavaScript Testing Framework with a focus on simplicity.

Simply run npm test to run the tests.

There are not enough tests, you can add more.

Style guide

This project uses JavaScript Standard Style. Please respect this convention.

You can install a plugin for your favorite editor if you want.

Pull request

Please PR to the develop branch! Then follow the pull request template.

Deploying / Publishing

Submit a pull request after running npm run build to ensure it runs correctly. The package is automatically published to npm when a new release is published on github.