Skip to content

Commit

Permalink
Merged Turborepo and Turbo Tooling CONTRIBUTING.md (#57)
Browse files Browse the repository at this point in the history
  • Loading branch information
NicholasLYang authored Oct 18, 2022
1 parent 6b231d5 commit 8caf3aa
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Turborepo

## Setup

Dependencies
Expand Down Expand Up @@ -54,3 +56,30 @@ To manually run a release:
2. Add `GORELEASER_KEY` env var with the GoReleaser Pro key (ask @turbo-oss to get access to the key)
3. Update `version.txt` (do not commit this change to git manually)
4. `cd cli && make publish`

# Turbo Tooling

`turbo-tooling` uses a [Cargo workspaces][workspaces] monorepo. You'll find
several workspaces inside the `crates/` directory. In order to run a particular
crate, you can use the `cargo run -p [CRATE_NAME]` command.

## Testing

Install `cargo-nextest` (https://nexte.st/)

Run via:

```shell
cargo nextest run
```

For the test cases you need to run `yarn` to install some node_modules. See [troubleshooting][] for solutions to common problems.

You can also create a little demo app and run

```shell
cargo run -p node-file-trace -- print demo/index.js
```

[workspaces]: https://doc.rust-lang.org/book/ch14-03-cargo-workspaces.html
[troubleshooting]: troubleshooting.md

0 comments on commit 8caf3aa

Please sign in to comment.