From f854410542d35909291fc901ca0def459fdb3990 Mon Sep 17 00:00:00 2001 From: Niels Date: Wed, 20 Jan 2016 21:20:41 +0100 Subject: [PATCH] added a note wrt. Valgrind (#175) --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b258f464..3e6258d4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -52,6 +52,10 @@ There are currently two files which need to be edited: Please understand that I cannot accept pull requests changing only file `src/json.hpp`. +## Note + +- If you open a pull request, the code will be automatically tested with [Valgrind](http://valgrind.org)'s Memcheck tool to detect memory leaks. Please be aware that the execution with Valgrind _may_ in rare cases yield different behavior than running the code directly. This can result in failing unit tests which run successfully without Valgrind. + ## Please don't - Only make changes to file `src/json.hpp` -- please read the paragraph above and understand why `src/json.hpp.re2c` exists.