j3d1/json
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

added a note wrt. Valgrind (#175)

Browse source
This commit is contained in:
Niels 2016-01-20 21:20:41 +01:00
parent 5c4624c351
commit f854410542
1 changed files with 4 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

4
CONTRIBUTING.md
View file

@ -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`. 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 ## Please don't
- Only make changes to file `src/json.hpp` -- please read the paragraph above and understand why `src/json.hpp.re2c` exists. - Only make changes to file `src/json.hpp` -- please read the paragraph above and understand why `src/json.hpp.re2c` exists.