From cf2501ba5e0e183cadaf0de1b1fa7265bdfa4ca4 Mon Sep 17 00:00:00 2001 From: Jesse Wierzbinski Date: Thu, 23 Nov 2023 09:16:48 -1000 Subject: [PATCH] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 22 ++++++++++++++++------ .github/ISSUE_TEMPLATE/feature_request.md | 22 +++++++++++++++------- 2 files changed, 31 insertions(+), 13 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 3cd7c411..333ead40 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,23 +7,33 @@ assignees: '' --- -**Describe the bug** +## Describe the bug + A clear and concise description of what the bug is. -**To Reproduce** +## Steps to reproduce + Steps to reproduce the behavior, such as a cURL command, HTTP request, situation or code repository -**Expected behavior** +## Expected behavior + A clear and concise description of what you expected to happen. -**Screenshots** +## Screenshots + If applicable, add screenshots to help explain your problem. -**Hardware** +## Logs + +Please upload logs onto a service like [Pastebin](https://pastebin.com/) or [Hastebin](https://hastebin.com/) and paste the link here. Don't paste the logs directly into the GitHub issue, as it just looks ugly and is hard to read. + +## Environment + - OS: [e.g. Fedora 39] - Bun version - Postgres version - Lysand commit ID or version -**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 11fc491e..c42339bb 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,14 +7,22 @@ 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 [...] +## Is your feature request related to a problem? Please describe. -**Describe the solution you'd like** -A clear and concise description of what you want to happen. +A clear and concise description of what the problem is, such as "I'm always frustrated when [...]" or "I can't do [...]" -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. +## Describe the solution you'd like + +What would you like to see implemented? + +## Describe alternatives you've considered + +If applicable, describe any alternative solutions or features you've considered. + +## Additional context -**Additional context** Add any other context or screenshots about the feature request here. + +## Are you willing to work on this feature? + +If you are willing to work on this feature, please say so here. \ No newline at end of file