Clarify bug report instructions.

This commit is contained in:
ryanheise 2020-07-02 01:53:04 +10:00 committed by GitHub
parent c14ce1498e
commit f7e2971426
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 22 deletions

View File

@ -7,30 +7,16 @@ assignees: ryanheise
--- ---
<!-- <!-- ALL SECTIONS BELOW MUST BE COMPLETED -->
**Which API doesn't behave as documented, and how does it misbehave?**
PLEASE READ CAREFULLY! Name here the specific methods or fields that are not behaving as documented, and explain clearly what is happening.
FOR YOUR BUG REPORT TO BE PROCESSED, YOU WILL NEED
TO FILL IN ALL SECTIONS BELOW. DON'T DELETE THE HEADINGS.
THANK YOU :-D
-->
**Describe the bug**
A clear and concise description of what the bug is.
**Minimal reproduction project** **Minimal reproduction project**
If the example project exhibits the bug, please mention that here, otherwise fork this project and modify the example to reproduce the bug. Provide the link to your repository here. Provide a link here using one of two options:
1. Fork this repository and modify the example to reproduce the bug, then provide a link here.
2. If the unmodified official example already reproduces the bug, just write "The example".
**To Reproduce** **To Reproduce (i.e. user steps, not code)**
Steps to reproduce the behavior: Steps to reproduce the behavior:
1. Go to '...' 1. Go to '...'
2. Click on '....' 2. Click on '....'
@ -40,12 +26,13 @@ Steps to reproduce the behavior:
**Error messages** **Error messages**
``` ```
If applicable, copy & paste error message here. If applicable, copy & paste error message here, within the triple quotes to preserve formatting.
``` ```
**Expected behavior** **Expected behavior**
A clear and concise description of what you expected to happen. A clear and concise description of what you expected to happen.
**Screenshots** **Screenshots**
If applicable, add screenshots to help explain your problem. If applicable, add screenshots to help explain your problem.