Skip to content

Latest commit

 

History

History
34 lines (22 loc) · 1.03 KB

CONTRIBUTING.md

File metadata and controls

34 lines (22 loc) · 1.03 KB

How to contribute

Submitting bug reports

If you want to report a bug you can use the repository's issue tracker or you can contact us directly by email; the latter should be preferred if you want to report a security vulnerability.

Contributing code

# clone the repo
git clone https://github.com/kabelwerk/sdk-js
cd sdk-js

# install the dependencies
npm install

# run the unit tests
npm test

# run prettier
npm run format

Demo

This project also comes with a simple React app for demo purposes. You can try out your changes in this demo app and/or you can also contribute code to the demo app itself. Please refer to demo/README.md for setup info.

Conventions

  • Follow the .editorconfig rules (take a look here if this is new for you).
  • Run Prettier using npm run format before making a commit.