mirror of
https://github.com/comit-network/xmr-btc-swap.git
synced 2025-08-24 14:15:55 -04:00
docs(dev): switch test instructions to nextest (#361)
This commit is contained in:
parent
0515f4e6ec
commit
60d2ee9f7e
3 changed files with 21 additions and 5 deletions
|
@ -9,12 +9,14 @@ There are a couple of things we are going to look out for in PRs and knowing the
|
|||
1. We have CI checks in place that validate formatting and code style.
|
||||
Make sure `dprint check` and `cargo clippy` both finish without any warnings or errors.
|
||||
If you don't already have it installed, you can obtain in [various ways](https://dprint.dev/install/).
|
||||
2. All text document (`CHANGELOG.md`, `README.md`, etc) should follow the [semantic linebreaks](https://sembr.org/) specification.
|
||||
3. We strive for atomic commits with good commit messages.
|
||||
2. Run the test suite with [cargo-nextest](https://nexte.st/docs/running/).
|
||||
Install it using `cargo install cargo-nextest` and execute `cargo nextest run`.
|
||||
3. All text document (`CHANGELOG.md`, `README.md`, etc) should follow the [semantic linebreaks](https://sembr.org/) specification.
|
||||
4. We strive for atomic commits with good commit messages.
|
||||
As an inspiration, read [this](https://chris.beams.io/posts/git-commit/) blogpost.
|
||||
An atomic commit is a cohesive diff with formatting checks, linter and build passing.
|
||||
Ideally, all tests are passing as well but we acknowledge that this is not always possible depending on the change you are making.
|
||||
4. If you are making any user visible changes, include a changelog entry.
|
||||
5. If you are making any user visible changes, include a changelog entry.
|
||||
|
||||
## Contributing issues
|
||||
|
||||
|
|
10
README.md
10
README.md
|
@ -14,3 +14,13 @@ If you're just here for the software, head over to the [releases](https://github
|
|||
Join our [Matrix room](https://matrix.to/#/#unstoppableswap-core:matrix.org) to follow development more closely.
|
||||
|
||||

|
||||
|
||||
## Running tests
|
||||
|
||||
This repository uses [cargo-nextest](https://nexte.st/docs/running/) to run the
|
||||
test suite.
|
||||
|
||||
```bash
|
||||
cargo install cargo-nextest
|
||||
cargo nextest run
|
||||
```
|
||||
|
|
8
justfile
8
justfile
|
@ -31,11 +31,15 @@ gui:
|
|||
|
||||
# Build the GUI
|
||||
gui_build:
|
||||
cd src-gui && yarn build
|
||||
cd src-gui && yarn build
|
||||
|
||||
# Run the Rust tests
|
||||
tests:
|
||||
cargo nextest run
|
||||
|
||||
# Tests the Rust bindings for Monero
|
||||
test_monero_sys:
|
||||
cd monero-sys && cargo test
|
||||
cd monero-sys && cargo nextest run
|
||||
|
||||
# Builds the ASB and Swap binaries
|
||||
swap:
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue