From 069ef99258f1141d5e74d3f644d0baa0b39fde27 Mon Sep 17 00:00:00 2001 From: Steven Peters Date: Tue, 26 Apr 2016 15:55:13 -0700 Subject: [PATCH] Recommend -j1 when running tests. Closes #409. --- CONTRIBUTING.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ef1dbfbd4..fd21feb9c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,3 +15,12 @@ We follow the [C++ ROS style guidelines](http://ros.org/wiki/CppStyleGuide) and conventions as closely as possible. However, because the plugins inherit from Gazebo classes and Gazebo follows a very different formatting standard, there are a few exceptions where Gazebo's function names do not comply to the ROS guidelines. + +## Tests + +We encourage developers to include tests in their pull requests when possible, +both for bug fixes and new features. +Examples of tests are in the `gazebo_plugins/test*` folders. +Currently the tests must not be run in parallel (see issue +[issue 409](https://github.com/ros-simulation/gazebo_ros_pkgs/issues/409)) +so it is recommented to use the `-j1` argument to `catkin run_tests`.