simdjson/.github/ISSUE_TEMPLATE/bug_report.md

---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug (unverified)
assignees: ''

---

Before submitting an issue, please ensure that you have read the documentation:

* Basics is an overview of how to use simdjson and its APIs: https://github.com/simdjson/simdjson/blob/master/doc/basics.md
* Performance shows some more advanced scenarios and how to tune for them: https://github.com/simdjson/simdjson/blob/master/doc/performance.md
* Contributing: https://github.com/simdjson/simdjson/blob/master/CONTRIBUTING.md
* We follow the [JSON specification as described by RFC 8259](https://www.rfc-editor.org/rfc/rfc8259.txt) (T. Bray, 2017).


**Describe the bug**
A clear and concise description of what the bug is.

A compiler or static-analyzer warning is not a bug.

We are committed to providing good documentation. We accept the lack of documentation or a misleading documentation as a bug (a 'documentation bug').

We accept the identification of an issue by a sanitizer or some checker tool (e.g., valgrind) as a bug, but you must first ensure that it is not a false positive.

We recommend that you run your tests using different optimization levels.

Before reporting a bug, please ensure that you have read our documentation.

**To Reproduce**
Steps to reproduce the behaviour: provide a code sample if possible.

If we cannot reproduce the issue, then we cannot address it. Note that a stack trace from your own program is not enough. A sample of your source code is insufficient: please provide a complete test for us to reproduce the issue. Please reduce the issue: use as small and as simple an example of the bug as possible.

It should be possible to trigger the bug by using solely simdjson with our default build setup. If you can only observe the bug within some specific context, with some other software, please reduce the issue first.

**simjson release**

Unless you plan to contribute to simdjson, you should only work from releases. Please be mindful that our main branch may have additional features, bugs and documentation items.

It is fine to report bugs against our main branch, but if that is what you are doing, please be explicit.

**Configuration (please complete the following information if relevant)**
 - OS: [e.g. Ubuntu 16.04.6 LTS]
 - Compiler [e.g. Apple clang version 11.0.3 (clang-1103.0.32.59) x86_64-apple-darwin19.4.0]
 - Version [e.g. 22]
 - Optimization setting (e.g., -O3)

We support up-to-date 64-bit ARM and x64 FreeBSD, macOS, Windows and Linux systems. Please ensure that your configuration is supported before labelling the issue as a bug. In particular, we do not support legacy 32-bit systems.

**Indicate whether you are willing or able to provide a bug fix as a pull request**

If you plan to contribute to simdjson, please read our
* CONTRIBUTING guide: https://github.com/simdjson/simdjson/blob/master/CONTRIBUTING.md and our
* HACKING guide: https://github.com/simdjson/simdjson/blob/master/HACKING.md
Update issue templates 2020-04-24 21:32:26 +08:00			`---`
			`name: Bug report`
			`about: Create a report to help us improve`
			`title: ''`
Update issue templates 2020-08-17 20:16:39 +08:00			`labels: bug (unverified)`
Update issue templates 2020-04-24 21:32:26 +08:00			`assignees: ''`

			`---`

			`Before submitting an issue, please ensure that you have read the documentation:`

			`* Basics is an overview of how to use simdjson and its APIs: https://github.com/simdjson/simdjson/blob/master/doc/basics.md`
			`* Performance shows some more advanced scenarios and how to tune for them: https://github.com/simdjson/simdjson/blob/master/doc/performance.md`
			`* Contributing: https://github.com/simdjson/simdjson/blob/master/CONTRIBUTING.md`
Tweaking further the documentation. (#1237) * Tweaking further the documentation. * More details. * Another sentence. * Saving. * Tweaking more 2020-10-20 04:51:04 +08:00			`* We follow the [JSON specification as described by RFC 8259](https://www.rfc-editor.org/rfc/rfc8259.txt) (T. Bray, 2017).`
Update issue templates 2020-04-24 21:32:26 +08:00

			`Describe the bug`
			`A clear and concise description of what the bug is.`

Update bug_report.md 2021-07-23 01:22:49 +08:00			`A compiler or static-analyzer warning is not a bug.`

			`We are committed to providing good documentation. We accept the lack of documentation or a misleading documentation as a bug (a 'documentation bug').`

			`We accept the identification of an issue by a sanitizer or some checker tool (e.g., valgrind) as a bug, but you must first ensure that it is not a false positive.`

			`We recommend that you run your tests using different optimization levels.`

			`Before reporting a bug, please ensure that you have read our documentation.`
Update issue templates 2020-08-17 20:16:39 +08:00
Update issue templates 2020-04-24 21:32:26 +08:00			`To Reproduce`
			`Steps to reproduce the behaviour: provide a code sample if possible.`

Update bug_report.md 2021-07-23 01:22:49 +08:00			`If we cannot reproduce the issue, then we cannot address it. Note that a stack trace from your own program is not enough. A sample of your source code is insufficient: please provide a complete test for us to reproduce the issue. Please reduce the issue: use as small and as simple an example of the bug as possible.`
Update issue templates 2020-08-17 20:16:39 +08:00
Update bug_report.md 2021-07-23 01:22:49 +08:00			`It should be possible to trigger the bug by using solely simdjson with our default build setup. If you can only observe the bug within some specific context, with some other software, please reduce the issue first.`
Update issue templates 2020-08-17 20:16:39 +08:00
Update bug_report.md 2021-07-23 01:22:49 +08:00			`simjson release`
Update bug_report.md 2021-06-07 21:57:43 +08:00
			`Unless you plan to contribute to simdjson, you should only work from releases. Please be mindful that our main branch may have additional features, bugs and documentation items.`

			`It is fine to report bugs against our main branch, but if that is what you are doing, please be explicit.`

Update bug_report.md 2021-07-23 01:22:49 +08:00			`Configuration (please complete the following information if relevant)`
Update issue templates 2020-04-24 21:32:26 +08:00			`- OS: [e.g. Ubuntu 16.04.6 LTS]`
			`- Compiler [e.g. Apple clang version 11.0.3 (clang-1103.0.32.59) x86_64-apple-darwin19.4.0]`
			`- Version [e.g. 22]`
Update bug_report.md 2021-07-23 01:22:49 +08:00			`- Optimization setting (e.g., -O3)`
Update issue templates 2020-04-24 21:57:10 +08:00
remove trailing whitespace (#1284) 2020-11-04 04:48:09 +08:00			`We support up-to-date 64-bit ARM and x64 FreeBSD, macOS, Windows and Linux systems. Please ensure that your configuration is supported before labelling the issue as a bug. In particular, we do not support legacy 32-bit systems.`
Update issue templates 2020-04-24 21:57:10 +08:00
			`Indicate whether you are willing or able to provide a bug fix as a pull request`

remove trailing whitespace (#1284) 2020-11-04 04:48:09 +08:00			`If you plan to contribute to simdjson, please read our`
Update issue templates 2020-04-24 21:57:10 +08:00			`* CONTRIBUTING guide: https://github.com/simdjson/simdjson/blob/master/CONTRIBUTING.md and our`
			`* HACKING guide: https://github.com/simdjson/simdjson/blob/master/HACKING.md`