Skip to content

Commit 60d2ee9

Browse files
authored
docs(dev): switch test instructions to nextest (#361)
1 parent 0515f4e commit 60d2ee9

File tree

3 files changed

+21
-5
lines changed

3 files changed

+21
-5
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,14 @@ There are a couple of things we are going to look out for in PRs and knowing the
99
1. We have CI checks in place that validate formatting and code style.
1010
Make sure `dprint check` and `cargo clippy` both finish without any warnings or errors.
1111
If you don't already have it installed, you can obtain in [various ways](https://dprint.dev/install/).
12-
2. All text document (`CHANGELOG.md`, `README.md`, etc) should follow the [semantic linebreaks](https://sembr.org/) specification.
13-
3. We strive for atomic commits with good commit messages.
12+
2. Run the test suite with [cargo-nextest](https://nexte.st/docs/running/).
13+
Install it using `cargo install cargo-nextest` and execute `cargo nextest run`.
14+
3. All text document (`CHANGELOG.md`, `README.md`, etc) should follow the [semantic linebreaks](https://sembr.org/) specification.
15+
4. We strive for atomic commits with good commit messages.
1416
As an inspiration, read [this](https://chris.beams.io/posts/git-commit/) blogpost.
1517
An atomic commit is a cohesive diff with formatting checks, linter and build passing.
1618
Ideally, all tests are passing as well but we acknowledge that this is not always possible depending on the change you are making.
17-
4. If you are making any user visible changes, include a changelog entry.
19+
5. If you are making any user visible changes, include a changelog entry.
1820

1921
## Contributing issues
2022

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,13 @@ If you're just here for the software, head over to the [releases](https://github
1414
Join our [Matrix room](https://matrix.to/#/#unstoppableswap-core:matrix.org) to follow development more closely.
1515

1616
![Screenshot 2024-11-21 at 6 19 03 PM](https://github.com/user-attachments/assets/a9fe110e-90b4-4af8-8980-d4207a5e2a71)
17+
18+
## Running tests
19+
20+
This repository uses [cargo-nextest](https://nexte.st/docs/running/) to run the
21+
test suite.
22+
23+
```bash
24+
cargo install cargo-nextest
25+
cargo nextest run
26+
```

justfile

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,15 @@ gui:
3131

3232
# Build the GUI
3333
gui_build:
34-
cd src-gui && yarn build
34+
cd src-gui && yarn build
35+
36+
# Run the Rust tests
37+
tests:
38+
cargo nextest run
3539

3640
# Tests the Rust bindings for Monero
3741
test_monero_sys:
38-
cd monero-sys && cargo test
42+
cd monero-sys && cargo nextest run
3943

4044
# Builds the ASB and Swap binaries
4145
swap:

0 commit comments

Comments
 (0)