From d66c37939acf6056c0d1eb6a57377874da10d158 Mon Sep 17 00:00:00 2001 From: Zach Gollwitzer Date: Wed, 5 Mar 2025 10:07:29 -0500 Subject: [PATCH] Update bug_report.md Signed-off-by: Zach Gollwitzer --- .github/ISSUE_TEMPLATE/bug_report.md | 51 +++++++++++++++++++++------- 1 file changed, 39 insertions(+), 12 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 203ba646..d7f8526c 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,32 +1,59 @@ --- name: Bug report -about: Create a report to help us improve +about: Open a bug report when you experience broken functionality within the latest version of the Maybe app title: 'Bug: [Add descriptive title here]' labels: '' assignees: '' --- -**Where did this bug occur? (required)** +## Before you start (required) -- [ ] I am a self-hosted user reporting a bug from my self hosted app - - [ ] I have verified that I am running the **latest** version of the Maybe app (your app should be running [this version](https://github.com/maybe-finance/maybe/pkgs/container/maybe) before opening a bug) -- [ ] I am a user of Maybe's paid app +### General checklist -_Please note, if you are reporting a bug with sensitive data, please open an Intercom chat from within the app for help_ +- [ ] I have removed personal / sensitive data from screenshots and logs +- [ ] I have searched [existing issues](https://github.com/maybe-finance/maybe/issues?q=is:issue) and [discussions](https://github.com/maybe-finance/maybe/discussions) to ensure this is not a duplicate issue + +### How are you using Maybe? + +- [ ] I am a paying Maybe customer (hosted version) +- [ ] I am a self-hosted user + +### Self hoster checklist + +_Paying, hosted users should delete this entire section._ + +If you are a self-hosted user, please complete all of the information below. Issues with incomplete information will be marked as `Needs Info` to help our small team prioritize bug fixes. + +- Self hosted app commit SHA (find in user menu): [enter commit sha here] + - [ ] I have confirmed that my app's commit is the latest version of Maybe +- Where are you hosting? + - [ ] Render + - [ ] Docker Compose + - [ ] Umbrel + - [ ] Other (please specify) + +--- + +## Bug description -**Describe the bug** A clear and concise description of what the bug is. -**To Reproduce** +### To Reproduce + +Be as specific as possible so Maybe maintainers can quickly reproduce the bug you're experiencing. + Steps to reproduce the behavior: + 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 -**Screenshots / Recordings** -If applicable, add screenshots or short video recordings to help show the bug in more detail. +What is the intended behavior that you would expect? + +### Screenshots and/or recordings + +We highly recommend providing additional context with screenshots and/or screen recordings. This will _significantly_ improve the chances of the bug being addressed and fixed quickly.