From a1aca0e76f5286d2ed0770add13f94544220344d Mon Sep 17 00:00:00 2001 From: AG3NTZ3R0 Date: Fri, 1 Mar 2024 10:34:13 -0500 Subject: [PATCH] Updates and issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 41 ++++++++++------------- .github/ISSUE_TEMPLATE/feature_request.md | 23 ++++++------- 2 files changed, 29 insertions(+), 35 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index dd84ea7..d83f049 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,38 +1,33 @@ --- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' +name: Bug Report +about: An issue used to report a bug to help improve this project. +title: '[BUG] ' +labels: bug assignees: '' - --- -**Describe the bug** -A clear and concise description of what the bug is. +### Overview +A clear and concise description of the bug. -**To Reproduce** -Steps to reproduce the behavior: +### Reproduction Procedure +A series of steps to reproduce the bug. 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error -**Expected behavior** -A clear and concise description of what you expected to happen. +### Expected Behavior +A clear and concise description of the expected behavior. -**Screenshots** +### Screenshots If applicable, add screenshots to help explain your problem. -**Desktop (please complete the following information):** - - 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] +### Desktop Information + - OS: [e.g. MacOS] + - IDE [e.g. VSCode, PyCharm] + - Python Version [e.g. 3.12] + - Pip Version [e.g. 22] + - CNBC Version [e.g. 1.0.0] -**Additional context** +### Additional Context Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index bbcbbe7..9543e37 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,20 +1,19 @@ --- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' +name: Feature Request +about: An issue used to suggest an idea for this project. +title: '[FEAT] ' +labels: feature 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 [...] +### Overview +Is your feature request related to a problem? Please describe the problem. -**Describe the solution you'd like** -A clear and concise description of what you want to happen. +### Proposed Solution +A clear and concise description of a solution. -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. +### Alternative Solution +A clear and concise description of an alternative solution you've considered. -**Additional context** +### Additional Context Add any other context or screenshots about the feature request here.