simdjson/.github/ISSUE_TEMPLATE/bug_report.md

41 lines
1.6 KiB
Markdown
Raw Normal View History

2020-04-24 21:32:26 +08:00
---
name: Bug report
about: Create a report to help us improve
title: ''
2020-08-17 20:16:39 +08:00
labels: bug (unverified)
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
**Describe the bug**
A clear and concise description of what the bug is.
2020-08-17 20:16:39 +08:00
Note that a compiler warning is not a bug.
2020-04-24 21:32:26 +08:00
**To Reproduce**
Steps to reproduce the behaviour: provide a code sample if possible.
2020-08-17 20:16:39 +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.
2020-04-24 21:32:26 +08:00
**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]
2020-04-24 21:57:10 +08:00
2020-07-27 03:58:35 +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.
2020-04-24 21:57:10 +08:00
**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