lenn/json
1
0
Fork 0
mirror of https://github.com/nlohmann/json.git synced 2025-11-24 11:54:34 +08:00
Code Issues Packages Projects Releases Wiki Activity

📝 overworked documentation wrt. amalgamation #906

Browse Source
This commit is contained in:
Niels Lohmann
2018-01-14 13:08:28 +01:00
parent fea5f3792b
commit 411c16cbb2
5 changed files with 30 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
.github/CONTRIBUTING.md vendored
View File

@@ -8,7 +8,7 @@ To make it as easy as possible for you to contribute and for me to keep an overv
## Private reports
Usually, all issues are tracked publicly on [Github](https://github.com/nlohmann/json/issues). If you want to make a private report (e.g., for a vulnerability or to attach an example that is not meant to be publisheed), please send an email to <mail@nlohmann.me>.
Usually, all issues are tracked publicly on [GitHub](https://github.com/nlohmann/json/issues). If you want to make a private report (e.g., for a vulnerability or to attach an example that is not meant to be published), please send an email to <mail@nlohmann.me>.
## Prerequisites
@@ -26,9 +26,11 @@ Please stick to the [issue template](https://github.com/nlohmann/json/blob/devel
## Files to change
There are currently two files which need to be edited:
:exclamation: Before you make any changes, note the single-header file [`src/json.hpp`](https://github.com/nlohmann/json/blob/develop/src/json.hpp) is **generated** from the source files in the [`develop` directory](https://github.com/nlohmann/json/tree/develop/develop). Please **do not** edit file `src/json.hpp` directly, but change the `develop` sources and regenerate file `src/json.hpp` by executing `make amalgamate`.
1. [`src/json.hpp`](https://github.com/nlohmann/json/blob/master/src/json.hpp)
To make changes, you need to edit the following files:
1. [`develop/*`](https://github.com/nlohmann/json/tree/develop/develop) - These files are the sources of the library. Before testing or creating a pull request, execute `make amalgamate` to regenerate `src/json.hpp`.
2. [`test/src/unit-*.cpp`](https://github.com/nlohmann/json/tree/develop/test/src) - These files contain the [Catch](https://github.com/philsquared/Catch) unit tests which currently cover [100 %](https://coveralls.io/github/nlohmann/json) of the library's code.