Skip to content

Commit 820b8b7

Browse files
committed
chore: update contributing page with test tag set, #6033
1 parent 4830d9d commit 820b8b7

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -371,13 +371,20 @@ A test should be marked `#[ignore]` if:
371371
2. Or, it runs for over a minute via a normal `cargo test` execution
372372
(the `cargo test` command will warn if this is not the case).
373373

374-
- Integration tests need to be properly tagged using [pinny-rs](https://github.com/BitcoinL2-Labs/pinny-rs/) crate. Tagging requires two fundamental steps:
374+
- **Integration tests need to be properly tagged** using [pinny-rs](https://github.com/BitcoinL2-Labs/pinny-rs/) crate. Tagging requires two fundamental steps:
375375
1. Define allowed tags in the package `Cargo.toml` file (if needed).
376376
2. Apply relevant tags to the tests, picking from the allowed set.
377377

378378
Then it will be possible to run tests with filtering based on the tags using `cargo test` and `cargo nextest` runner.
379+
> For more information and examples on how tagging works, refer to the [pinny-rs](https://github.com/BitcoinL2-Labs/pinny-rs/) readme.
379380
380-
For more information and examples on how tagging works, refer to the [pinny-rs](https://github.com/BitcoinL2-Labs/pinny-rs/) readme.
381+
Below the tag set currently defined with related purpose:
382+
383+
| Tag | Description |
384+
|-----------------|----------------------------------------------|
385+
| `slow` | tests running over a minute |
386+
| `bitcoind` | tests requiring bitcoin daemon |
387+
| `flaky` | tests that exhibit flaky behavior |
381388

382389
## Formatting
383390

0 commit comments

Comments
 (0)