Skip to content

Commit

Permalink
[chore]: more contribute instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
jchip committed Sep 1, 2020
1 parent 3b84adc commit d21eb81
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit d21eb81

Please sign in to comment.