From e5de07acdc27ea768bad78a37338a7b920c46b8c Mon Sep 17 00:00:00 2001 From: Adam Wulkiewicz Date: Mon, 26 May 2014 06:00:02 -0700 Subject: [PATCH] Updated Contribution Tutorial (markdown) --- Contribution-Tutorial.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/Contribution-Tutorial.md b/Contribution-Tutorial.md index 04b3465..16476a5 100644 --- a/Contribution-Tutorial.md +++ b/Contribution-Tutorial.md @@ -212,10 +212,21 @@ As it's mentioned in the GIT documentation (http://git-scm.com/book/en/Distribut As you already know tests are placed in the `test/` directory. Add tests for the newly added feature and if you added new files modify the Jamfile as well. +* Run all unit tests before submit, even the tests of features you did not work on. +* Check your contribution with two compilers: + * on Windows you can use Visual Studio and MinGW/GCC or VirtualBox/GCC + * on Linux you can use GCC and Clang +* It's preferable to do this before sending the merge/pull request. +* Consider using additional compiler options like -Wall, -Wextra, -Wconversion to catch more bugs. + Run the tests (assuming you're in `modular-boost/libs/geometry/`) b2 test +If you wanted to pass some compiler options use `cxxflags` parameter + + b2 test cxxflags="-Wall" + #### Push At the end, push your changes to the remote branch