From b6401075661e16a5aac9ad3898e27ac35c77c300 Mon Sep 17 00:00:00 2001 From: Nils Winkler Date: Sat, 14 Oct 2017 18:09:58 +0200 Subject: [PATCH] Added list of test libraries (bats-assert etc.) --- CONTRIBUTING.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1f0aa4a4..04451473 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -58,11 +58,20 @@ To run the test suite, simply execute the following in the directory where you c test/run ``` -This command will ensure that the [Bats Test Framework](https://github.com/bats-core/bats-core) is available in a local directory (it's included as a Git submodule) and then run the test suite found in the [test](test) folder. +This command will ensure that the [Bats Test Framework](https://github.com/bats-core/bats-core) is available in the local `test_lib` directory (Bats is included as a Git submodule) and then run the test suite found in the [test](test) folder. The test script will execute each test in turn, and will print a status for each test case. When adding new test cases, please take a look at the existing test cases for examples. +The following libraries are used to help with the tests: + +* Test Framework: https://github.com/bats-core/bats-core +* Support library for Bats-Assert: https://github.com/ztombol/bats-support +* General `assert` functions: https://github.com/ztombol/bats-assert +* File `assert` functions: https://github.com/ztombol/bats-file + +When verifying test results, please try to use the `assert` functions found in these libraries. + ## Features * When adding new completions or plugins, please don't simply copy existing tools into the Bash-it codebase, try to load/integrate the tools instead.