haraldwolff/json
1
0
Fork 0
mirror of https://github.com/nlohmann/json.git synced 2024-07-05 13:56:59 +02:00
Code Issues Packages Projects Releases Wiki Activity
json/.github/PULL_REQUEST_TEMPLATE.md
Niels Lohmann 99ee4c1eaf
🔨 cleaned up Makefiles and docs #698
2017-10-04 19:27:35 +02:00

2.5 KiB
Raw Blame History

Files to change

There are currently two files which need to be edited:

  1. src/json.hpp

  2. test/src/unit.cpp - This contains the Catch unit tests which currently cover 100 % of the library's code.

    If you add or change a feature, please also add a unit test to this file. The unit tests can be compiled and executed with

    $ mkdir build
$ cd build
$ cmake ..
$ make
$ ctest

    The test cases are also executed with several different compilers on Travis once you open a pull request.

Note

  • If you open a pull request, the code will be automatically tested with Valgrind'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

  • The C++11 support varies between different compilers and versions. Please note the list of supported compilers. Some compilers like GCC 4.8 (and earlier), Clang 3.3 (and earlier), or Microsoft Visual Studio 13.0 and earlier are known not to work due to missing or incomplete C++11 support. Please refrain from proposing changes that work around these compiler's limitations with #ifdefs or other means.
  • Specifically, I am aware of compilation problems with Microsoft Visual Studio (there even is an issue label for these kind of bugs). I understand that even in 2016, complete C++11 support isn't there yet. But please also understand that I do not want to drop features or uglify the code just to make Microsoft's sub-standard compiler happy. The past has shown that there are ways to express the functionality such that the code compiles with the most recent MSVC - unfortunately, this is not the main objective of the project.
  • Please refrain from proposing changes that would break JSON conformance. If you propose a conformant extension of JSON to be supported by the library, please motivate this extension.
  • Please do not open pull requests that address multiple issues.