From d18f409dd3178b274a19f61034e1a8ac3afd8878 Mon Sep 17 00:00:00 2001 From: Morgan Date: Wed, 5 Jun 2024 09:00:09 -0500 Subject: [PATCH] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 25 ++++++++++--------------- 1 file changed, 10 insertions(+), 15 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index eb5916d..e870819 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -8,14 +8,15 @@ assignees: mxndtaylor --- **Describe the bug** -A clear and concise description of what the bug is. +A clear and concise description of what the bug is, should not be more than a sentence or maybe two. +Add anything more than that to additional context please. **To Reproduce** Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error +1. define class with "..." +2. use [`aliasing` feature] '....' +3. ... +4. Encounter issue **Expected behavior** A clear and concise description of what you expected to happen. @@ -23,16 +24,10 @@ A clear and concise description of what you expected to happen. **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] +**Machine Information (please complete the following information):** + - OS: [e.g. ubuntu] +- `python` version: [`aliasing` should support `python` 3.8+] + - `aliasing` version: [e.g. 0.3.1] **Additional context** Add any other context about the problem here.