Skip to content

Commit 465b8ff

Browse files
authored
docs: update setup and test docs with missing info (#4567)
## What ❔ Fixes the development setup docs to accurately reflect some missing information - cargo-nextest must be installed with `--version 0.9.109 --locked` as the latest version does not support rust 1.87 - `zkstack dev contracts` must be run before running unit tests <!-- What are the changes this PR brings about? --> <!-- Example: This PR adds a PR template to the repo. --> <!-- (For bigger PRs adding more context is appreciated) --> ## Why ❔ Accurate documentation is helpful for new and external contributors to be able to set up a working developer environment <!-- Why are these changes done? What goal do they contribute to? What are the principles behind them? --> <!-- The `Why` has to be clear to non-Matter Labs entities running their own ZK Chain --> <!-- Example: PR templates ensure PR reviewers, observers, and future iterators are in context about the evolution of repos. --> ## Is this a breaking change? - [ ] Yes - [x] No ## Operational changes <!-- Any config changes? Any new flags? Any changes to any scripts? --> <!-- Please add anything that non-Matter Labs entities running their own ZK Chain may need to know --> None ## Checklist <!-- Check your PR fulfills the following items. --> <!-- For draft PRs check the boxes as you complete them. --> - [ ] PR title corresponds to the body of PR (we generate changelog entries from PRs). - [ ] Tests for the changes have been added / updated. - [ ] Documentation comments have been added / updated. - [ ] Code has been formatted via `zkstack dev fmt` and `zkstack dev lint`.
1 parent 7c4c428 commit 465b8ff

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

docs/src/guides/development.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,12 @@ Commands:
123123

124124
### Running unit tests
125125

126+
Unit tests require preprocessed artifacts from the contracts submodule. These can be prepared by running:
127+
128+
```bash
129+
zkstack dev contracts
130+
```
131+
126132
You can run unit tests for the Rust crates in the project by running:
127133

128134
```bash

docs/src/guides/setup-dev.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ npm install -g yarn
4141
yarn set version 1.22.19
4242

4343
# For running unit tests
44-
cargo install cargo-nextest
44+
cargo install cargo-nextest --version 0.9.109 --locked
4545
# SQL tools
4646
cargo install sqlx-cli --version 0.8.1
4747

0 commit comments

Comments
 (0)