From eac07a51ba3299e2007e8aaca4f35edf7ec4804d Mon Sep 17 00:00:00 2001 From: Cory LaViska Date: Thu, 23 Sep 2021 09:32:53 -0400 Subject: [PATCH] update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 40 +++++++++++------------ .github/ISSUE_TEMPLATE/feature_request.md | 15 ++++----- 2 files changed, 25 insertions(+), 30 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 423d5124..af8a9b3d 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,38 +1,36 @@ --- name: Bug Report -about: Create a report to help us improve. +about: Create a bug report to help us fix a demonstrable problem with code in the library. title: '' labels: bug assignees: claviska --- -**Describe the bug** -A clear and concise description of what the bug is. +### Describe the bug +A bug is _a demonstrable problem_ caused by code in the library. Please provide a clear and concise description of what the bug is here. -**To Reproduce** +### To Reproduce Steps to reproduce the behavior: + 1. Go to '...' -2. Click on '....' -3. Scroll down to '....' +2. Click on '...' +3. Scroll down to '...' 4. See error -**Expected behavior** -A clear and concise description of what you expected to happen. +### Demo -**Screenshots** -If applicable, add screenshots to help explain your problem. +If the bug isn't obvious, please provide a link to a CodePen or Fiddle with a minimal reproduction. Bugs that have repros get attention faster than those that don't. -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] +Tip: use the CodePen button on any example in the docs! -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] +### Screenshots +If applicable, add screenshots to help explain the bug. -**Additional context** -Add any other context about the problem here. +### Browser / OS + - OS: [e.g. Mac, Windows] + - Browser [e.g. Chrome, Firefox, Safari] + - Browser version [e.g. 22] + +### Additional information +Provide any additional information about the bug here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index c1926889..1f020ff7 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,14 +7,11 @@ assignees: claviska --- -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +### What issue are you having? +Provide a clear and concise description of the problem you're facing. -**Describe the solution you'd like** -A clear and concise description of what you want to happen. +### Describe the solution you'd like +How would you like to see the library solve it? -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. +### Describe alternatives you've considered +In what ways have you tried to solve this with the current version?