docs: Add FAQ reminder to bug report template #5011
Closed
+0
−93
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This change addresses issue nlohmann#4898 and related duplicate reports where users encounter different behavior between Linux and Windows when using push_back with braced json objects. The issue is caused by brace initialization behavior, which is documented as a known limitation in the FAQ at https://json.nlohmann.me/home/faq/#brace-initialization-yields-arrays By adding a prominent reminder to check the FAQ before reporting, we hope to reduce the frequency of duplicate issue reports for this known behavior. Signed-off-by: duvvuvenkataramana <[email protected]>
gregmarr
reviewed
Nov 24, 2025
Signed-off-by: duvvuvenkataramana <[email protected]>
Author
|
@gregmarr @nlohmann I've updated the bug report template so that the FAQ reminder is now placed in the correct location—right after the note that the form is for bug reports only, as suggested. This should make the guidance clearer for users and help reduce duplicate issue reports. Please let me know if any further changes are needed. Happy to adjust anything! |
Contributor
|
@duvvuvenkataramana That looks better. I'll let @nlohmann comment on the overall changes. |
nlohmann
reviewed
Nov 24, 2025
Signed-off-by: duvvuvenkataramana <[email protected]>
Author
Author
|
@nlohmann Now I added valuable links . Check |
Signed-off-by: duvvuvenkataramana <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change addresses issue #4898 and related duplicate reports where users encounter different behavior between Linux and Windows when using push_back with braced json objects.
The issue is caused by brace initialization behavior, which is documented as a known limitation in the FAQ at https://json.nlohmann.me/home/faq/#brace-initialization-yields-arrays
By adding a prominent reminder to check the FAQ before reporting, we hope to reduce the frequency of duplicate issue reports for this known behavior.
[Describe your pull request here. Please read the text below the line and make sure you follow the checklist.]
make amalgamate.Read the Contribution Guidelines for detailed information.