Skip to content

Latest commit

 

History

History
48 lines (33 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

48 lines (33 loc) · 1.55 KB
Raw

Contributing

Reporting Bugs

When submitting a new bug report, please first search for an existing or similar report. If no duplicate exists, file the issue with the following information:

  1. OS version.
  2. Steps to reproduce the issue.
  3. Example code snippet that causes the issue.
  4. Screenshots of the broken UI.

Development

Clone this repo and install Node v16. Below are commands we use to perform various tasks:

  • npm install, install dependencies.
  • npm run compile, run compiler.
  • npm run build, build SDK assets.
  • npm run test, run unit tests.
  • npm run lint, run linter.
  • npm run format, run code formatter.

Publishing a new version

  1. Update CHANGELOG.md with any changes that need to be communicated to a user of the SDK. See https://keepachangelog.com/en/1.1.0/ for details on what and how content should be included.
  2. Run npm version <new version> to set the new SDK version and create the git tag.
  3. Publish new version to npm.

Publishing to npm

You will need permission to publish to the mxenabled organization in npm before you can publish this package. Once you are able to publish, log into npm with npm login then run npm publish to publish. Note that running npm publish will automatically execute npm run build:dist for you, so there is no need to do that manually.