Contribution Guiding

Developing

Install with yarn
Transpile code: yarn build (or yarn build:watch)
Run it using nebula development server with yarn start
- The development server needs to connect to and communicate with the Qlik Associative Engine running within any of Qlik's product offerings.
- For the Saas Edition of Qlik Sense, you can add your webIntegrationId and pointing the engine URL to your tenant following Nebula serve configuration file or the introduction page of http://localhost:8000 when you run the development server.
Or, Upload the /dist folder as an extension on Qlik Sense Enterprise for Windows or Qlik Sense SaaS

Testing

Run unit tests with:

yarn test

Linting

Run lint with:

yarn lint

Type checking

Run type checking with:

yarn types:check

Releasing

Currently only admins are able to create a release. A release consists of the following:

Bumping the package version based on your commits
Updating the API specification
Creating a new commit with the changed files
Creating a tag with the new version
Pushing the release commit and tag to master

Step-By-Step

Check out master and run git pull.
Run git clean -dfx && yarn to make sure depenencies are up-to-date.
Run npm version [major | minor | patch] -m "chore(release): v%s". Use semver string based on conventional commits since last release. Ex: npm version patch -m "chore(release): v%s".
Run git push && git push --tags to push commit and tag.
Make sure all checks pass, then Circle CI automatically publishes to NPM.

On version command failure

If you would run npm version and it for some reason fails, or you would like to revert the tag you just created:

Run git tag to check if a new tag was created (or already existed).
If a tag was created, delete it with git tag -d <tag>.