mirror of
https://github.com/actualbudget/actual.git
synced 2026-03-21 06:58:47 -05:00
* Improve bug report template with better structure and requirements * Fix: Remove empty value fields from textarea inputs in bug report template * Add release notes for PR #6784 * Update 6784.md * Update bug report template to request a screenshot of the import screen along with a redacted file version for better issue resolution. * Update bug report template for import issues Clarified instructions for reporting import issues. --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
117 lines
4.2 KiB
YAML
117 lines
4.2 KiB
YAML
name: Bug Report
|
|
description: File a bug report also known as an issue or problem.
|
|
title: '[Bug]: '
|
|
labels: ['needs triage', 'bug']
|
|
type: Bug
|
|
body:
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
Thanks for taking the time to fill out this bug report! Please ensure you provide as much information as possible to better assist in confirming and identifying a fix for the bug.
|
|
|
|
⚠️ **CRITICAL:** Bug reports without clear, step-by-step reproduction instructions will be closed. We cannot investigate or fix bugs without being able to reproduce them. Please take the time to provide detailed reproduction steps.
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
**IMPORTANT:** we use GitHub Issues only for BUG REPORTS and FEATURE REQUESTS. If you are looking for help/support - please reach out to the [community on Discord](https://discord.gg/pRYNYr4W5A). All non-bug and non-feature-request issues will be closed.
|
|
|
|
**Bank-sync problems (SimpleFin / GoCardless)?** Reach out via the [community Discord](https://discord.gg/pRYNYr4W5A) first and open an issue only if the community deems the issue to be a legitimate bug in Actual.
|
|
- type: textarea
|
|
id: what-happened
|
|
attributes:
|
|
label: What happened?
|
|
description: |
|
|
Describe the bug clearly and concisely. Include:
|
|
- What you were trying to do
|
|
- What you expected to happen
|
|
- What actually happened instead
|
|
- Any error messages (copy/paste the exact text)
|
|
|
|
If you're reporting an issue with imports, please include a (redacted) version of the file, and a screenshot of the import screen. You may need to zip it before uploading.
|
|
placeholder: |
|
|
I was trying to [action] when [context].
|
|
Expected: [expected behavior]
|
|
Actual: [actual behavior]
|
|
Error message: [if any]
|
|
validations:
|
|
required: true
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
## Reproduction Steps
|
|
|
|
**REQUIRED:** Without clear reproduction steps, we cannot investigate or fix the bug. Please provide detailed, step-by-step instructions that anyone can follow to reproduce the issue.
|
|
- type: textarea
|
|
id: reproduction
|
|
attributes:
|
|
label: How can we reproduce the issue?
|
|
description: |
|
|
**This field is mandatory and must be filled out completely.**
|
|
|
|
Provide numbered, step-by-step instructions that allow us to reproduce the bug. Include:
|
|
- Specific actions you took (e.g., "Click on the Budget tab", "Enter $100 in the amount field")
|
|
- What you expected to happen
|
|
- What actually happened instead
|
|
|
|
Example format:
|
|
1. Navigate to [specific page/section]
|
|
2. Click on [specific button/link]
|
|
3. Enter [specific data] in [specific field]
|
|
4. Click [action]
|
|
5. Observe [expected vs actual behavior]
|
|
|
|
If the issue involves importing data, please attach a (redacted) sample file. You may need to zip it before uploading.
|
|
placeholder: |
|
|
1. Go to [specific location]
|
|
2. Click [specific element]
|
|
3. Enter [specific data]
|
|
4. Click [action]
|
|
5. Expected: [what should happen]
|
|
Actual: [what actually happens]
|
|
validations:
|
|
required: true
|
|
- type: markdown
|
|
attributes:
|
|
value: '## Environment Details'
|
|
- type: dropdown
|
|
id: hosting
|
|
attributes:
|
|
label: Where are you hosting Actual?
|
|
description: Where are you running your instance of Actual from?
|
|
options:
|
|
- Locally via Yarn
|
|
- Docker
|
|
- Fly.io
|
|
- Pikapods
|
|
- NAS
|
|
- Desktop App (Electron)
|
|
- Other
|
|
validations:
|
|
required: false
|
|
- type: dropdown
|
|
id: browsers
|
|
attributes:
|
|
label: What browsers are you seeing the problem on?
|
|
multiple: true
|
|
options:
|
|
- Firefox
|
|
- Chrome
|
|
- Safari
|
|
- Microsoft Edge
|
|
- Desktop App (Electron)
|
|
- Other
|
|
- type: dropdown
|
|
id: operating-system
|
|
attributes:
|
|
label: Operating System
|
|
description: What operating system are you using?
|
|
options:
|
|
- Windows 11
|
|
- Windows 10
|
|
- Mac OSX
|
|
- Linux
|
|
- Mobile Device
|
|
- Other
|
|
validations:
|
|
required: false
|