Skip to content

Commit

Permalink
fix: types error in xarc-app-dev package (#8)
Browse files Browse the repository at this point in the history
* fix: types error in xarc-app-dev package

* docs: update to contribution guidelines

* docs: update to contribution guidelines
  • Loading branch information
arunvishnun committed Mar 24, 2023
1 parent b013a17 commit 02be629
Show file tree
Hide file tree
Showing 3 changed files with 1,197 additions and 1,119 deletions.
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,21 @@ $ rush install # installs package dependencies for all packages, based on the sh
$ rush build # Run build command on all projects whose source files have changed since the last successful build
```

### Useful Commands

`rush install` - Installs package dependencies for all
packages, based on the shrinkwrap file that is created/updated using "rush update".
It is recommended to use this if you do not want to make changes to *lock files. CI jobs use this command for the same reason.

`rush update` - Installs the dependencies described in the package.
json files, and updates the shrinkwrap file as needed.

`rush build` - Run this command after install step to perform build on all packages. These are incremental builds. In other words, it only builds projects whose source files have changed since the last successful build.

`rush test` - Runs test on all packages. A `test` script is required in package.json for all packages.

`rushx <command>` - Executes `scripts` mentioned in individual packages. This command should be ran within a package directory.

### Try a sample

Now you can go to the `samples` folder and try the `create-app-demo` sample app, develop and test your changes over there. This is the exact same app that our create-app package generates.
Expand All @@ -39,6 +54,7 @@ And when you open the browser at `http://localhost:3000`, you should see the dem
- You should bootstrap the entire repo at the top dir at least once with `rush install`
- After you make changes to any module under packages, if you want to test them in one of the samples, just run `` rushx <command>`` in that sample and it will ensure all changed local packages are properly rebuilt and installed.


#### Test with `@xarc/create-app`

You can quickly use the `xarc-create-app` package to create an app for testing.
Expand Down
Loading

0 comments on commit 02be629

Please sign in to comment.