Skip to content

Commit d30e21c

Browse files
committed
Move the testing guide
1 parent a7f93ce commit d30e21c

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

docs/docs/developer-guide.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,34 @@
11
# Developer Guide
22

33
_This site is under construction._
4+
5+
## Testing
6+
7+
Testing is essential for delivering good and reliable software.
8+
PushBits uses Go's integrated test features.
9+
Unfortunately, writing tests is quite time consuming and therefore not every feature and every line of code is automatically tested.
10+
Feel free to help us improve our tests.
11+
12+
To run tests for a single (sub)module you can simply execute the following command in the module's folder.
13+
14+
```bash
15+
go test
16+
```
17+
18+
To get the testing coverage for a module use the `-cover` flag.
19+
20+
```bash
21+
go test -cover
22+
```
23+
24+
To execute a single test use the `-run` flag.
25+
26+
```bash
27+
go test -run "TestApi_getUser"
28+
```
29+
30+
Running tests for all PushBits module is done like this:
31+
32+
```bash
33+
make test
34+
```

0 commit comments

Comments
 (0)