Skip to content

Commit e20280f

Browse files
Nicorettichristian-schilling
authored andcommitted
Add documentation on how to contrbute
1 parent 9fe701b commit e20280f

File tree

3 files changed

+41
-0
lines changed

3 files changed

+41
-0
lines changed

docs/src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,6 @@
1717
- [Handlebar generator]()
1818
- [The josh UI]()
1919
# Contributing
20+
- [Testing](./contributing/testing.md)
2021
- [Development tools]()
2122
- [Tracing]()

docs/src/contributing/dev-tools.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Dev-Tools
2+
3+
* Nix-Shell
4+
- curl
5+
- brew trunk
6+
* Cram
7+
* Cargo/Rustup

docs/src/contributing/testing.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Dev Tools
2+
3+
## Nix-Shell
4+
* [Nix Shell](https://nixos.org/manual/nix/stable/#chap-installation)
5+
6+
7+
# Testing
8+
9+
1. Install Nix-Shell
10+
2. Setup Nix-Shell for testing
11+
```shell
12+
nix-shell shell.nix
13+
```
14+
3. build
15+
* filter
16+
* proxy
17+
* trunk build in ui
18+
19+
20+
## Unit Tests
21+
```shell
22+
cargo test --all
23+
```
24+
25+
## Integration Tests
26+
* Build all targets
27+
* run integration tests
28+
```shell
29+
sh run-tests.sh tests/
30+
```
31+
32+
## UI Tests
33+
TBD

0 commit comments

Comments
 (0)