From ff1aa8ad70c1a2f75a46f8fa3966499805bf078b Mon Sep 17 00:00:00 2001
From: Li Kang <kkllpaul7766@gmail.com>
Date: Mon, 30 May 2022 19:06:27 +0200
Subject: [PATCH] docs(contributing): add packages and development worlflow
 (#836)

---
 .github/CONTRIBUTING.md       | 10 ++++++++--
 .storybook/webpack.config.js  |  2 +-
 apis/locale/locales/README.md |  5 +++--
 scripts/start-mashup.js       | 11 +++++------
 4 files changed, 17 insertions(+), 11 deletions(-)

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 3f7a42374..36a9a9d1e 100644
--- a/.github/CONTRIBUTING.md
+++ b/.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 run build`
+- `yarn` install all dependencies
+- `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
diff --git a/.storybook/webpack.config.js b/.storybook/webpack.config.js
index 5d45910c6..b27e4739f 100644
--- a/.storybook/webpack.config.js
+++ b/.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;
diff --git a/apis/locale/locales/README.md b/apis/locale/locales/README.md
index fc93e36a6..e5fc5e827 100644
--- a/apis/locale/locales/README.md
+++ b/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).
diff --git a/scripts/start-mashup.js b/scripts/start-mashup.js
index 4056bcf45..aeef3f47d 100644
--- a/scripts/start-mashup.js
+++ b/scripts/start-mashup.js
@@ -4,12 +4,11 @@ const yargs = require('yargs');
 
 const mashupServer = require('../test/mashup/server');
 
-const args = yargs
-  .option('start', {
-    default: true,
-    type: 'boolean',
-    describe: 'Start the mashup server',
-  }).argv;
+const args = yargs.option('start', {
+  default: true,
+  type: 'boolean',
+  describe: 'Start the mashup server',
+}).argv;
 
 const { start } = args;