diff options
Diffstat (limited to 'bootstrap/vagrant-onap/CONTRIBUTING.md')
| -rw-r--r-- | bootstrap/vagrant-onap/CONTRIBUTING.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/bootstrap/vagrant-onap/CONTRIBUTING.md b/bootstrap/vagrant-onap/CONTRIBUTING.md new file mode 100644 index 000000000..e473927e4 --- /dev/null +++ b/bootstrap/vagrant-onap/CONTRIBUTING.md @@ -0,0 +1,25 @@ +First off, thank you for considering contributing to ONAP on Vagrant project. +It's people like you that make it such a great tool. + +ONAP on Vagrant is an open source project and we love to receive contributions +from our community — you! There are many ways to contribute, from writing +tutorials or blog posts, improving the documentation, submitting bug reports and +feature requests or writing code which can be incorporated into ONAP on Vagrant +itself. + +Unit Testing +============ + +The **_tests_** folder contains ~~scripts~~ _test suites_ that ensure the proper +implementation of the _functions_ created on **_lib_** folder. In order to +execute the Unit Tests defined for this project, you must run the following +command: + + $ ./tools/run.sh testing [test_suite] [function] + +Examples +-------- + + $ ./tools/run.sh testing # Executes all the Unit Tests + $ ./tools/run.sh testing functions # Executes all the Unit Tests of Functions Test Suite + $ ./tools/run.sh testing functions install_maven # Executes the install_maven Unit Test of Functions Test Suite |