Git-Mirrors/xmr-btc-swap
1
0
Fork 0
mirror of https://github.com/comit-network/xmr-btc-swap.git synced 2025-08-24 22:19:37 -04:00
Code Issues Projects Releases Packages Wiki Activity

docs(dev): switch test instructions to nextest (#361)

Browse source
This commit is contained in:
Mohan 2025-05-27 11:05:49 +02:00 • committed by GitHub
parent 0515f4e6ec
commit 60d2ee9f7e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 21 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

8
CONTRIBUTING.md
View file

@ -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. 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. 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/). 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. 2. Run the test suite with [cargo-nextest](https://nexte.st/docs/running/).
3. We strive for atomic commits with good commit messages. 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. 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. 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. 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 ## Contributing issues

10
README.md
View file

@ -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. Join our [Matrix room](https://matrix.to/#/#unstoppableswap-core:matrix.org) to follow development more closely.
![Screenshot 2024-11-21 at 6 19 03 PM](https://github.com/user-attachments/assets/a9fe110e-90b4-4af8-8980-d4207a5e2a71) ![Screenshot 2024-11-21 at 6 19 03 PM](https://github.com/user-attachments/assets/a9fe110e-90b4-4af8-8980-d4207a5e2a71)
## 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
View file

@ -31,11 +31,15 @@ gui:
# Build the GUI # Build the GUI
gui_build: 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 # Tests the Rust bindings for Monero
test_monero_sys: test_monero_sys:
cd monero-sys && cargo test cd monero-sys && cargo nextest run
# Builds the ASB and Swap binaries # Builds the ASB and Swap binaries
swap: swap: