From ade365502540138326f9c3dcfe75147549fa9632 Mon Sep 17 00:00:00 2001 From: Robert Kieffer Date: Thu, 30 Jul 2020 17:36:59 -0700 Subject: [PATCH] chore: improved bug report template (#501) * chore: improved bug report template See if we can encourage users to provide better examples by adding a party-popper checkbox that lets them confirm they've actually read and understand the SO page on what a good example looks like. * typo * chore: npm run prettier:fix --- .github/ISSUE_TEMPLATE/bug_report.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 2cc386b5..211fc5f1 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -13,19 +13,17 @@ version before filing your bug report. Node.js 13.x is NOT supported by this lib ## Describe the bug -A clear and concise description of what the bug is. +[Clear, concise description of the problem] -## To Reproduce +## How to reproduce -Steps to reproduce the behavior: +[Instructions for how we (the `uuid` maintainers) can reproduce the problem] -1. Install '...' -2. Run '....' -3. See error +- [ ] 🎉 This is a "[Minimal, Complete, and Verifiable](https://stackoverflow.com/help/minimal-reproducible-example)" Example 🎉 ## Expected behavior -A clear and concise description of what you expected to happen. +[Clear, concise description of what you expected] ## Runtime @@ -33,6 +31,6 @@ A clear and concise description of what you expected to happen. - Runtime: [e.g. Node.js, Chrome, Safari, react-native, AWS Lambda] - Runtime Version: [e.g. 14.2.0] -## Additional context +## Additional information -Add any other context about the problem here. +[Any other information or comments that you think will help]