From 064e0da18a4f0d8f1d629518a02396ea219af79a Mon Sep 17 00:00:00 2001 From: Abdul Rabbani Date: Tue, 19 Apr 2022 17:48:33 -0400 Subject: [PATCH] Update Templates --- .github/ISSUE_TEMPLATE/bug_report.md | 57 ++++++++++++++++------- .github/ISSUE_TEMPLATE/feature_request.md | 34 +++++++++----- 2 files changed, 62 insertions(+), 29 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index dd84ea7..a9ec3df 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,38 +1,61 @@ --- name: Bug report about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - +title: "" +labels: "" +assignees: "" --- -**Describe the bug** +- [Describe the bug](#describe-the-bug) +- [To Reproduce](#to-reproduce) +- [Expected behavior](#expected-behavior) +- [Evidence](#evidence) + - [Logs](#logs) + - [Screenshots](#screenshots) +- [Additional context](#additional-context) + +Table of contents generated with markdown-toc + +# Describe the bug + A clear and concise description of what the bug is. -**To Reproduce** +# To Reproduce + Steps to reproduce the behavior: + 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error -**Expected behavior** +# Expected behavior + A clear and concise description of what you expected to happen. -**Screenshots** +# Evidence + +## Logs + +Provide any logs if applicable. + +## Screenshots + If applicable, add screenshots to help explain your problem. +# Additional context + +Add any other context about the problem here. + **Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] + +- OS: [e.g. iOS] +- Browser [e.g. chrome, safari] +- Version [e.g. 22] **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] -**Additional context** -Add any other context about the problem here. +- Device: [e.g. iPhone6] +- OS: [e.g. iOS8.1] +- Browser [e.g. stock browser, safari] +- Version [e.g. 22] diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index bbcbbe7..f642407 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,20 +1,30 @@ --- name: Feature request about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - +title: "" +labels: "" +assignees: "" --- -**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 [...] +- [Request](#request) + - [Potentialy Solution](#potentialy-solution) + - [Alternative Solutions](#alternative-solutions) +- [Additional Context](#additional-context) -**Describe the solution you'd like** -A clear and concise description of what you want to happen. +Table of contents generated with markdown-toc -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. +# Request -**Additional context** -Add any other context or screenshots about the feature request here. +**Explain what you want and why. If this feature is related to a problem please highlight it here.** + +## Potentialy Solution + +**Provide any details for a potential solution.** + +## Alternative Solutions + +**Provide any alternative solutions.** + +# Additional Context + +**Provide Additional Context.**