From f7e2971426c3e803b470d9c4e18289040459c946 Mon Sep 17 00:00:00 2001 From: ryanheise Date: Thu, 2 Jul 2020 01:53:04 +1000 Subject: [PATCH] Clarify bug report instructions. --- .github/ISSUE_TEMPLATE/bug-report.md | 31 ++++++++-------------------- 1 file changed, 9 insertions(+), 22 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 651e243..bbd2a31 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -7,30 +7,16 @@ assignees: ryanheise --- - - -**Describe the bug** -A clear and concise description of what the bug is. + +**Which API doesn't behave as documented, and how does it misbehave?** +Name here the specific methods or fields that are not behaving as documented, and explain clearly what is happening. **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: 1. Go to '...' 2. Click on '....' @@ -40,12 +26,13 @@ Steps to reproduce the behavior: **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** A clear and concise description of what you expected to happen. + **Screenshots** If applicable, add screenshots to help explain your problem.