From 5940a42f939d0b45405c16109c5b5d4e278d4a86 Mon Sep 17 00:00:00 2001 From: Eduardo Leao <121963234+eduardoleao052@users.noreply.github.com> Date: Fri, 5 Apr 2024 22:18:58 -0300 Subject: [PATCH] Update issue templates To help organize any issues related to __bugs__ or __suggested features__, I've included issue templates. This will make response times better, and bugs easier to fix! --- .github/ISSUE_TEMPLATE/bug_report.md | 40 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 17 ++++++++++ 2 files changed, 57 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..10da617 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,40 @@ +--- +name: Bug report +about: Thank you for sharing this bug report! Please fill out the template so that + the error is clearer, and quicker to fix :D +title: "[BUG]" +labels: '' +assignees: eduardoleao052 + +--- + +## Describe the bug +A clear and concise description of what the bug is. + +## Example +### Code +A small code snippet that exemplifies the bug: +```typescript +function doesntWork(arg1, arg2) { + // Some logic... + return result; +} +``` + +### Resulting Error (optional) +A ctrl+c ctrl+v of your Stack Trace: +``` +Error: variable 'a' is declared but never used. +``` + +## To Reproduce +Steps to reproduce the behavior: +1. Go to '...' +2. Run '....' +3. See error + +## Expected behavior +A clear and concise description of what you expected to happen. + +## Screenshots (Optional) +If applicable, add screenshots to help explain your problem. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..2edbf26 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,17 @@ +--- +name: Feature request +about: Suggest an idea for this project! Any feature, change or fix is much appreciated. +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 [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Additional context** +Add any other context or screenshots about the feature request here.