Skip to content

Commit

Permalink
Update CONTRIBUTING [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
yutannihilation committed Apr 14, 2024
1 parent dfd0335 commit 681dc54
Showing 1 changed file with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,15 @@ Contributing to savvy
### savvy crate

As savvy framework requires a real R session to work, `cargo test` doesn't work.
Instead, please use `savvy-cli test`.
Instead, please use `savvy-cli test`. This extracts test code and creates a
temporary R package on-the-fly to run these tests.

```console
```sh
savvy-cli test .

# if you want to use the dev version of savvy-cli
cargo r-test
```

This extracts test code and creates a
temporary R package on-the-fly to run these tests.
if you want to use the dev version of savvy-cli, you can run `cargo r-test`,
which is an alias of `cargo run --manifest-path ./savvy-cli/Cargo.toml -- test`.

The binary of [`savvy-cli`] is found on the [GitHub Releases][release]. You can
also install it via `cargo install`.
Expand All @@ -34,7 +32,8 @@ Currently, it also requires

#### R package for testing

`R-package/` directory contains the R package for testing.
`R-package/` directory contains the R package for testing. You can run
`devtools::check()` on the directory.

### savvy-macro crate

Expand All @@ -47,14 +46,14 @@ Getting Started][insta-install].
If you create a new snapshot or modify an existing snapshot, you can review and
accept the changes with:

```console
```sh
cargo insta review
```

### savvy-bindgen crate

You can just run `cargo test`.

```console
```sh
cargo test --manifest-path=./savvy-bindgen/Cargo.toml
```
```

0 comments on commit 681dc54

Please sign in to comment.