From d21eb8146d649811f12d27ced5339f9232b24bfd Mon Sep 17 00:00:00 2001 From: Joel Chen Date: Tue, 1 Sep 2020 00:32:09 -0700 Subject: [PATCH] [chore]: more contribute instructions --- CONTRIBUTING.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 965d9eb6f..e6d748a8b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,7 +13,7 @@ This repo uses [Lerna] as a top level setup and [fyn] to manage Node Modules. Install these CLI tools globally: [xclap-cli] and [fyn] ```bash -$ npm install -g xclap-cli fyn +$ npm install -g xclap-cli @xarc/run-cli fyn $ fyn -V 0.2.41 ``` @@ -47,6 +47,16 @@ After running above, you should see a similar text as `Hapi.js server running at And when you open the browser at `http://localhost:3000`, you should see a large Electrode icon with a few demonstration components. +### **Important** Notes + +**Bootstrapping** + +- You must bootstrap the entire repo at the top dir at least once with `clap bootstrap` +- Every time you pull down new changes or switch a branch, you should run bootstrap again. +- Every time you make changes to a package that another depends on, you must bootstrap them again. +- You can bootstrap a single package only: ie: `npx fynpo bootstrap --only @xarc/app-dev` + - This will ensure all its locally dependent packages are bootstrapped also. + #### Test with `@xarc/create-app` You can quickly use the `xarc-create-app` package to create an app for testing.