From bf17eebd9d7bd2dcc99c25c97a5517ef6681176b Mon Sep 17 00:00:00 2001 From: Philip O'Toole Date: Sun, 17 Apr 2016 19:37:42 -0700 Subject: [PATCH] Add notes re unit testing PRs --- CONTRIBUTING.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e8334a89..0de12de8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,3 +39,19 @@ Follow the steps below to work with a fork: ``` Retaining the directory structure `$GOPATH/src/github.com/otoolep` is necessary so that Go imports work correctly. + +## Testing +Be sure to run the unit test suite before opening a pull request. An example test run is shown below. +```bash +$ cd $GOPATH/src/github.com/otoolep/rqlite +$ go test ./... +? github.com/otoolep/rqlite [no test files] +ok github.com/otoolep/rqlite/auth 0.001s +? github.com/otoolep/rqlite/cmd/rqlite [no test files] +? github.com/otoolep/rqlite/cmd/rqlited [no test files] +ok github.com/otoolep/rqlite/db 0.769s +ok github.com/otoolep/rqlite/http 0.006s +ok github.com/otoolep/rqlite/store 6.117s +ok github.com/otoolep/rqlite/system_test 7.853s +``` +