You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,17 +22,17 @@ Clearly describe the issue:
22
22
- If you propose a change or addition, try to give an**example** how the improved code could look like or how to use it.
23
23
- If you found a compilation error, please tell us which**compiler** (version and operating system) you used and paste the (relevant part of) the error messages to the ticket.
24
24
25
-
Please stick to the provided issuetemplates ([bug report](https://github.com/nlohmann/json/blob/develop/.github/ISSUE_TEMPLATE/Bug_report.md),[feature request](https://github.com/nlohmann/json/blob/develop/.github/ISSUE_TEMPLATE/Feature_request.md),or[question](https://github.com/nlohmann/json/blob/develop/.github/ISSUE_TEMPLATE/question.md)) if possible.
25
+
Please stick to the provided issuetemplate ([bug report](https://github.com/nlohmann/json/blob/develop/.github/ISSUE_TEMPLATE/bug.yml) if possible. For questions, featureorsupport requests, please[open a discussion](https://github.com/nlohmann/json/discussions/new).
26
26
27
27
##Files to change
28
28
29
-
:exclamation: Before you make any changes, note the single-headerfile[`single_include/nlohmann/json.hpp`](https://github.com/nlohmann/json/blob/develop/single_include/nlohmann/json.hpp)is**generated** from the source files in the[`include/nlohmann` directory](https://github.com/nlohmann/json/tree/develop/include/nlohmann). Please**do not** editfile`single_include/nlohmann/json.hpp` directly, but change the`include/nlohmann` sources and regeneratefile`single_include/nlohmann/json.hpp` by executing`make amalgamate`.
29
+
:exclamation: Before you make any changes, note the single-headerfiles[`single_include/nlohmann/json.hpp`](https://github.com/nlohmann/json/blob/develop/single_include/nlohmann/json.hpp)and[`single_include/nlohmann/json_fwd.hpp`](https://github.com/nlohmann/json/blob/develop/single_include/nlohmann/json_fwd.hpp) are**generated** from the source files in the[`include/nlohmann` directory](https://github.com/nlohmann/json/tree/develop/include/nlohmann). Please**do not** editthe files`single_include/nlohmann/json.hpp`and`single_include/nlohmann/json_fwd.hpp`directly, but change the`include/nlohmann` sources and regeneratethe files by executing`make amalgamate`.
30
30
31
31
To make changes, you need to edit the following files:
32
32
33
-
1.[`include/nlohmann/*`](https://github.com/nlohmann/json/tree/develop/include/nlohmann) - These files are the sources of the library. Before testing or creating a pull request, execute`make amalgamate` to regenerate`single_include/nlohmann/json.hpp`.
33
+
1.[`include/nlohmann/*`](https://github.com/nlohmann/json/tree/develop/include/nlohmann) - These files are the sources of the library. Before testing or creating a pull request, execute`make amalgamate` to regenerate`single_include/nlohmann/json.hpp` and`single_include/nlohmann/json_fwd.hpp`.
34
34
35
-
2.[`test/src/unit-*.cpp`](https://github.com/nlohmann/json/tree/develop/test/src) - These files contain the[doctest](https://github.com/onqtam/doctest) unit tests which currently cover[100 %](https://coveralls.io/github/nlohmann/json) of the library's code.
35
+
2.[`tests/src/unit-*.cpp`](https://github.com/nlohmann/json/tree/develop/tests/src) - These files contain the[doctest](https://github.com/onqtam/doctest) unit tests which currently cover[100 %](https://coveralls.io/github/nlohmann/json) of the library's code.
36
36
37
37
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
Copy file name to clipboardExpand all lines: .github/PULL_REQUEST_TEMPLATE.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ Read the [Contribution Guidelines](https://github.com/nlohmann/json/blob/develop
9
9
-[ ] Changes are described in the pull request, or an[existing issue is referenced](https://github.com/nlohmann/json/issues).
10
10
-[ ] The test suite[compiles and runs](https://github.com/nlohmann/json/blob/develop/README.md#execute-unit-tests) without error.
11
11
-[ ][Code coverage](https://coveralls.io/github/nlohmann/json) is 100%. Test cases can be added by editing the[test suite](https://github.com/nlohmann/json/tree/develop/test/src).
12
-
-[ ] The source code is amalgamated; that is, after making changes to the sources in the`include/nlohmann` directory, run`make amalgamate` to create the single-headerfile`single_include/nlohmann/json.hpp`. The whole process is described[here](https://github.com/nlohmann/json/blob/develop/.github/CONTRIBUTING.md#files-to-change).
12
+
-[ ] The source code is amalgamated; that is, after making changes to the sources in the`include/nlohmann` directory, run`make amalgamate` to create the single-headerfiles`single_include/nlohmann/json.hpp` and`single_include/nlohmann/json_fwd.hpp`. The whole process is described[here](https://github.com/nlohmann/json/blob/develop/.github/CONTRIBUTING.md#files-to-change).