diff options
| author | Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> | 2018-03-13 03:35:24 -0700 |
|---|---|---|
| committer | Richard van der Hoff <github@rvanderhoff.org.uk> | 2018-03-13 10:35:24 +0000 |
| commit | 2ccf9f3a32b0a25c35bde49e2cd8faa6742ab3c6 (patch) | |
| tree | d76854fe6140c2f2a26149796efdf054885b68ba /CONTRIBUTING.md | |
| parent | b72ed3e38c33d9a31eb9dd3441a599e13ee75c4b (diff) | |
Explain gb test output (#420)
`gb test`s output is confusing as it is similar to that of `gb build`.
Rather than building, it's actually running all the tests. If no output
past this shows, then all tests have succeeded.
Updates CONTRIBUTING.md to include a note about this.
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 256106fa..99c85331 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,8 +13,10 @@ instance of dendrite, and [CODE_STYLE.md](CODE_STYLE.md) for the code style guide. We use `gb` for managing our dependencies, so `gb build` and `gb test` is how -to build dendrite and run the unit tests respectively. There are [scripts](scripts) -for [linting](scripts/find-lint.sh) and doing a [build/test/lint run](scripts/build-test-lint.sh). +to build dendrite and run the unit tests respectively. Be aware that a list of +all dendrite packages is the expected output for all tests succeeding with `gb +test`. There are also [scripts](scripts) for [linting](scripts/find-lint.sh) +and doing a [build/test/lint run](scripts/build-test-lint.sh). ## Picking Things To Do |