Files
Enterprise-Knowledge-Base/.github/ISSUE_TEMPLATE/bug_report.yml
T
wizardchen f0b1851281 docs(issues): require concrete app/UI versions instead of "latest"
Update the bug report and question issue templates to direct users to
the Settings → System Info page and ask for the concrete "App Version"
and "UI Version" values shown there, explicitly disallowing "latest",
"main" or "master" as answers. This pairs with the new UI Version row
on the System Info page so version-mismatch bugs (e.g. SearXNG
base_url field missing on stale UI builds) can be triaged at a glance.
2026-05-13 17:54:15 +08:00

131 lines
3.6 KiB
YAML

name: 🐛 Bug Report
description: Report a bug or issue
title: "[Bug]: "
labels: ["bug", "needs-triage"]
body:
- type: markdown
attributes:
value: |
Thanks for reporting a bug! Please fill in the information below to help us locate and fix the issue quickly.
- type: dropdown
id: component
attributes:
label: Affected Component
description: Select the component where the issue occurs
options:
- Frontend UI
- Backend Service & API
- Document Reader Service
- Vector Database
- Model Service
- Other
validations:
required: true
- type: textarea
id: description
attributes:
label: Bug Description
description: A clear and concise description of the issue
placeholder: "Describe what the bug looks like..."
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to Reproduce
description: Minimal steps that reliably reproduce the problem
placeholder: |
1. Go to '...'
2. Click on '...'
3. Send request '...'
4. See error
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected Behavior
description: Describe what you expected to happen
placeholder: "What should have happened..."
validations:
required: true
- type: textarea
id: actual
attributes:
label: Actual Behavior
description: Describe what actually happened (error messages, screenshots, etc.)
placeholder: "What actually happened..."
validations:
required: true
- type: input
id: version
attributes:
label: WeKnora Version
description: |
Please provide the concrete version number you are running, **not** `latest`, `main` or `master`.
You can find it on the **Settings → System Info** page (both "App Version" and "UI Version" — if they differ, please report both).
If you built from source, include the commit SHA instead.
placeholder: "e.g., App Version: v0.5.2, UI Version: v0.5.2 (or commit abc1234)"
validations:
required: true
- type: dropdown
id: deployment
attributes:
label: Deployment Method
description: How are you running WeKnora?
options:
- Docker Compose
- Build from source
- Lite (single binary)
- Desktop app
- Kubernetes (Helm)
- Other
validations:
required: true
- type: input
id: os
attributes:
label: Operating System
description: The operating system you are using
placeholder: "e.g., macOS 13.0, Ubuntu 20.04, Windows 11"
validations:
required: true
- type: markdown
attributes:
value: |
## 📋 Log Collection Guide
Please collect logs and paste them into the field below. Pick the command matching your deployment:
- Docker Compose:
```bash
docker compose logs -f --tail=1000 app docreader postgres
```
- Lite / Desktop / build from source: include the console output or log files (e.g., `logs/*.log`).
- type: textarea
id: logs
attributes:
label: Relevant Logs
description: Paste relevant logs or error messages here
placeholder: "Paste logs or error messages..."
render: shell
- type: checkboxes
id: terms
attributes:
label: Confirmation
description: Please confirm the following
options:
- label: I have searched existing issues and confirmed this is a new one
required: true