From ebdf5e9fd757fc899b56ddf2449a4eb836dd2c13 Mon Sep 17 00:00:00 2001 From: "Andrew Morgan (https://amorgan.xyz)" Date: Fri, 9 Mar 2018 21:14:36 -0800 Subject: [PATCH] Explain gb test output `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. --- CONTRIBUTING.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 256106faa..99c85331a 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