Skip to content

Commit

Permalink
docs: how to test
Browse files Browse the repository at this point in the history
  • Loading branch information
joaothallis committed May 4, 2024
1 parent d908c9b commit 8a00670
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,25 @@ cargo run --release -- -c config.toml --network signet run
```

### Running the tests

#### Requirements

```bash
cargo build
```

There's a set of unit tests that you can run with
```bash
cargo test
```

There's also a set of functional tests that you can run with

```bash
pip3 install -r tests/requirements.txt
python tests/run_tests.py
```

### Contributing
Contributions are welcome, feel free to open an issue or a pull request. There's not really a set of guidelines for contributing other than the code compiling and the tests passing. If you want to contribute but don't know where to start, take a look at the issues, there's a few of them marked as `good first issue`.

Expand Down

0 comments on commit 8a00670

Please sign in to comment.