From 784f28613099dc7e162d20f113986b8b88614711 Mon Sep 17 00:00:00 2001 From: Kesari3008 <65543166+Kesari3008@users.noreply.github.com> Date: Fri, 12 Apr 2024 10:52:02 +0530 Subject: [PATCH] Update CONTRIBUTING.md Updating the missing step for linking dependent repo's locally --- CONTRIBUTING.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d44e9de7..bd3c67d1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -166,10 +166,12 @@ Below you can find sample steps for linking a local `components` package to the ```bash git clone git@github.com:webex/components.git ``` + 2. Build `components` code. This will generate a `dist` folder ```bash cd components npm install + npx npm-install-peers (This is required to install peer dependencies if npm version is lower than 7) npm run build ``` @@ -178,11 +180,13 @@ Below you can find sample steps for linking a local `components` package to the "@webex/components": "file:../components", // Or corresponding path to local clone npm install ``` -4. Install dependencies of `widgets` repository and the react dependency (this is required because`components` repository uses react) + +4. Install peer dependencies of `widgets` repository and the react dependency (this is required because`components` repository uses react) ``` npx npm-install-peers npm link ../components/node_modules/react ``` + 5. Start up the widget sample ``` npm run start