@@ -2,93 +2,101 @@ name: Bug Report
22description : Create a bug report
33labels :
44 - ' kind: bug'
5+
56body :
67 - type : markdown
78 attributes :
89 value : >
910 Thanks for taking the time to fill out this bug report!
10-
11+
1112 Make sure you give it a short and specific **title** so that the report
1213 is searchable and uniquely identifiable.
13-
14- Note that this form is for bug reports only. Please
15- **Please check the [FAQ](https://json.nlohmann.me/home/faq/) before reporting an issue.** Common questions are answered there.
16- [open a discussion](https://github.com/nlohmann/json/discussions/new)
17- for questions, feature requests, or support requests.
14+
15+ Note that this form is for **bug reports only**.
16+
17+ **Please check the [FAQ](https://json.nlohmann.me/home/faq/) before reporting an issue.**
18+ Common questions are answered there.
19+
20+ For questions, feature requests, or support, please
21+ [open a discussion](https://github.com/nlohmann/json/discussions/new).
22+
1823 - type : textarea
1924 id : summary
2025 attributes :
2126 label : Description
2227 description : >
23- Please provide an abstract description of the issue to the developers,
24- and why you consider it to be a bug. Please include any specific links
25- to the documentation, JSON specification , or code .
28+ Provide a clear and concise description of the issue and explain why
29+ you consider it a bug. Include any relevant documentation links,
30+ JSON specifications , or references .
2631 validations :
2732 required : true
33+
2834 - type : textarea
2935 id : reproduce
3036 attributes :
3137 label : Reproduction steps
3238 description : >
33- How do you trigger the bug? Please walk us through step by step. Be as
34- specific as possible.
39+ Describe how to reproduce the issue step by step. Be as specific and
40+ detailed as possible.
3541 validations :
3642 required : true
43+
3744 - type : textarea
3845 id : results
3946 attributes :
4047 label : Expected vs. actual results
4148 description : >
42- Please describe what you expected to happen after the steps above and
43- what actually happened.
49+ Explain what you expected to happen and what actually occurred.
4450 validations :
4551 required : true
52+
4653 - type : textarea
4754 id : code
4855 attributes :
4956 label : Minimal code example
5057 description : >
51- If possible, provide a small and self-contained example that triggers
52- the bug. Please understand that we cannot analyze and debug large code
53- bases. Please do not paste screenshots here.
58+ If possible, provide a small and self-contained code snippet that
59+ triggers the bug. Avoid including large code bases. Do not paste screenshots.
5460 render : Shell
61+
5562 - type : textarea
5663 id : output
5764 attributes :
5865 label : Error messages
5966 description : >
60- Please provide any kind of error output ( compilation errors, exception
61- messages, stack traces, etc.) which can help to diagnose the error .
67+ Provide any compilation errors, exception messages, stack traces,
68+ or other output that helps diagnose the issue .
6269 render : Shell
70+
6371 - type : input
6472 id : compiler
6573 attributes :
6674 label : Compiler and operating system
6775 description : >
68- On which operating systems and compilers have you observed the issue?
69- Include as many relevant details about the environment you experienced
70- the bug in. Make sure you use a
71- [supported compiler](https://github.com/nlohmann/json#supported-compilers).
76+ Specify the operating systems and compilers where you observed the issue.
77+ Include all relevant details. Ensure you are using a
78+ supported compiler.
7279 validations :
7380 required : true
81+
7482 - type : input
7583 id : version
7684 attributes :
7785 label : Library version
7886 description : >
79- Which version of the library did you use? If it is a released version,
80- please enter the version number (e.g., 3.12.0). Otherwise, please enter
81- the commit hash. If you got the library from another source as the
82- GitHub repository (e.g., via a package manager), please also state
83- this.
87+ Which version of the library are you using?
88+ If you used a release, provide the version number (e.g., 3.12.0).
89+ If using a development build, provide the commit hash.
90+ If installed via a package manager, please mention that as well.
8491 validations :
8592 required : true
93+
8694 - type : checkboxes
8795 id : validation
8896 attributes :
8997 label : Validation
9098 description : >
91- Please check these additional steps :
99+ Please confirm the following :
92100 options :
93- - label : The bug also occurs if the latest version from the [`develop`](https://github.com/nlohmann/json/tree/develop) branch is used .
94- - label : I can successfully [ compile and run the unit tests](https://github.com/nlohmann/json#execute-unit-tests) .
101+ - label : The bug also occurs when using the latest version from the [`develop`](https://github.com/nlohmann/json/tree/develop) branch.
102+ - label : I can successfully compile and run the unit tests.
0 commit comments