docs(contributing): add packages and development worlflow (#836)

.github/CONTRIBUTING.md

@@ -37,6 +37,11 @@ This is a multi-package repository which uses [lerna](https://github.com/lerna/l
   - `nucleus`: JavaScript library for mashups
   - `supernova`: JavaScript API for consuming and visualizing QIX data
   - `stardust`: Public JavaScript API which exposes the nucleus and supernova APIs
+  - `enigma-mocker`: Public JavaScript API which creates a mocked enigma app to renders visualizations without a connected Qlik engine
+  - `snapshooter`: Public JavaScript API which captures rendered charts as images
+  - `conversion`: [private] Provides conversion functionality to extensions with hyperCubes.
+  - `theme`: [private] Access/consume the currently applied theme
+  - `locale`: [private] Handle translation string to generate all locales
 - `commands` - CLI commands
   - `build`: cli command to build a supernova
   - `cli`: entry point for all cli commands
@@ -49,9 +54,10 @@ This is a multi-package repository which uses [lerna](https://github.com/lerna/l
 
 ### Development workflow
 
-- `yarn` generates UMD bundles for all packages
+- `yarn` install all dependencies
-- `yarn run build`
+- `yarn run build` generates UMD bundles for all packages and a ESM bundle for stardust
 - `yarn run lint` checks code style
+- `yarn run format` format code style
 - `yarn run test` runs all tests
 
 ### Cutting a release

.storybook/webpack.config.js

@@ -1,5 +1,5 @@
 module.exports = ({ config }) => {
-  const jsRule = config.module.rules.find(rule => rule.test.test('.js'));
+  const jsRule = config.module.rules.find((rule) => rule.test.test('.js'));
   jsRule.exclude = /node_modules/;
 
   return config;

apis/locale/locales/README.md

@@ -1,10 +1,11 @@
 # Locale specific strings
 
-The English resource (string) container [`en-US.json`](./en-US.json) on `master` is monitored for changes. All modifications will automatically be picked up and propagated to the other locale files by the Globalization Services team at Qlik at regular intervals (weekly). 
+The English resource (string) container [`en-US.json`](./en-US.json) on `master` is monitored for changes. All modifications will automatically be picked up and propagated to the other locale files by the Globalization Services team at Qlik at regular intervals (weekly).
 
 ## Pull requests touching English string resources
+
 Please add [dechabot (Dan Chabot)](https://github.com/dechabot) for review on all PRs touching [English string resources](./en-US.json), to ensure changes are consistent with style guides and translatability requirements.
 
-**Important** 
+**Important**
 
 Any changes to **non-English files** will be overwritten on next translation delivery. If you need to modify the non-English strings for any reason, please contact Qlik Globalization Services via [@qlik-oss/globalization](https://github.com/orgs/qlik-oss/teams/globalization).

scripts/start-mashup.js

@@ -4,12 +4,11 @@ const yargs = require('yargs');
 
 const mashupServer = require('../test/mashup/server');
 
-const args = yargs
+const args = yargs.option('start', {
-  .option('start', {
+  default: true,
-    default: true,
+  type: 'boolean',
-    type: 'boolean',
+  describe: 'Start the mashup server',
-    describe: 'Start the mashup server',
+}).argv;
-  }).argv;
 
 const { start } = args;