mirror of
https://github.com/louislam/uptime-kuma.git
synced 2025-06-01 11:22:34 +02:00
a4f9e75f50
- Updated descriptions and placeholders for clearer instructions and consistency. - Fixed minor formatting and content issues to better align with documentation standards. - Enhanced the "Deployment Environment" section to offer better guidance for users. modified: .github/ISSUE_TEMPLATE/bug_report.yml
136 lines
5 KiB
YAML
136 lines
5 KiB
YAML
---
|
|
name: "🐛 Bug Report"
|
|
description: "Submit a bug report to help us improve"
|
|
#title: "[Bug] "
|
|
labels: ["bug", "P2-medium"]
|
|
body:
|
|
- type: "markdown"
|
|
attributes:
|
|
value: |
|
|
## **❗ Important: Please Avoid Unnecessary Pinging of Maintainers**
|
|
|
|
**We kindly ask users to refrain from pinging maintainers unless absolutely necessary. Pings should be reserved for critical issues or urgent matters that require immediate attention.**
|
|
|
|
- **Why**: To help maintainers focus on high-priority tasks, we kindly request that unnecessary or repeated pings be minimized. This will help ensure quicker responses for matters that truly need attention.
|
|
- **What This Means**: Non-urgent pings may be ignored or addressed later. Please assess the urgency of your request before pinging a maintainer.
|
|
- type: textarea
|
|
id: related-issues
|
|
validations:
|
|
required: true
|
|
attributes:
|
|
label: "📑 I have found these related issues/pull requests"
|
|
description: "Search related issues by clicking
|
|
[HERE](https://github.com/louislam/uptime-kuma/issues?q=) and explain
|
|
what the difference between them or explain that you are unable to find
|
|
any related issues"
|
|
placeholder:
|
|
"Related to #1 by also touching the ... system. They should not be
|
|
merged because ..."
|
|
- type: checkboxes
|
|
attributes:
|
|
label: "🛡️ Security Policy"
|
|
description:
|
|
Please review the security policy before reporting security related
|
|
issues/bugs.
|
|
options:
|
|
- label: I agree to have read this project [Security
|
|
Policy](https://github.com/louislam/uptime-kuma/security/policy)
|
|
required: true
|
|
- type: textarea
|
|
id: description
|
|
validations:
|
|
required: false
|
|
attributes:
|
|
label: "Description"
|
|
description: "You could also upload screenshots"
|
|
- type: textarea
|
|
id: steps-to-reproduce
|
|
validations:
|
|
required: true
|
|
attributes:
|
|
label: "👟 Reproduction steps"
|
|
description:
|
|
"How do you trigger this bug? Please walk us through it step by step.
|
|
Include all important details and add screenshots where appropriate"
|
|
placeholder: "..."
|
|
- type: textarea
|
|
id: expected-behavior
|
|
validations:
|
|
required: true
|
|
attributes:
|
|
label: "👀 Expected behavior"
|
|
description: "What did you think would happen?"
|
|
placeholder: "..."
|
|
- type: textarea
|
|
id: actual-behavior
|
|
validations:
|
|
required: true
|
|
attributes:
|
|
label: "😓 Actual Behavior"
|
|
description: "What actually happen?"
|
|
placeholder: "..."
|
|
- type: input
|
|
id: uptime-kuma-version
|
|
attributes:
|
|
label: "🐻 Uptime-Kuma Version"
|
|
description: "What version of Uptime-Kuma are you running? Please do not provide Docker tags like `latest` or `1`."
|
|
placeholder: "e.g., 1.23.16 or 2.0.0-beta.2"
|
|
validations:
|
|
required: true
|
|
- type: input
|
|
id: operating-system
|
|
attributes:
|
|
label: "💻 Operating System and Arch"
|
|
description:
|
|
"Which OS is your server/device running on? (For Replit, please do not
|
|
report this bug)"
|
|
placeholder: "e.g., Ubuntu Server 24.04.2 LTS (GNU/Linux 6.8.0-55-generic x86_64)"
|
|
validations:
|
|
required: true
|
|
- type: input
|
|
id: browser-vendor
|
|
attributes:
|
|
label: "🌐 Browser"
|
|
description: "Which browser are you running on?"
|
|
placeholder: "e.g., Google Chrome 134.0.6998.183 (Official Build) (64-bit)"
|
|
validations:
|
|
required: true
|
|
- type: textarea
|
|
id: deployment-info
|
|
attributes:
|
|
label: "🖥️ Deployment Environment"
|
|
description: |
|
|
Provide details about the deployment environment, including runtime components, databases, and storage configurations.
|
|
This will help assess the infrastructure and identify any potential compatibility requirements.
|
|
|
|
**Remove any fields that do not apply to your setup.**
|
|
value: |
|
|
- **Runtime Environment**:
|
|
- Docker: Version `X.X.X` (Build `Y.Y.Y`)
|
|
- Docker Compose: Version `X.X.X`
|
|
- Portainer (BE/CE): Version `X.X.X` (LTS: Yes/No)
|
|
- MariaDB: Version `X.X.X` (LTS: Yes/No)
|
|
- Node.js: Version `X.X.X` (LTS: Yes/No)
|
|
- Kubernetes (K3S/K8S): Version `X.X.X` (LTS: Yes/No, via `[method/tool]`)
|
|
- **Database**:
|
|
- SQLite: Embedded
|
|
- MariaDB: Embedded/External
|
|
- **Database Storage**:
|
|
- **Filesystem**:
|
|
- Linux: ext4/XFS/Btrfs/ZFS/F2FS
|
|
- macOS: APFS/ HFS+
|
|
- Windows: NTFS/ReFS
|
|
- **Storage Medium**: HDD/eMMC/SSD/NVMe
|
|
- **Uptime Kuma Setup**:
|
|
- Number of monitors: `X`
|
|
validations:
|
|
required: true
|
|
- type: textarea
|
|
id: logs
|
|
attributes:
|
|
label: "📝 Relevant log output"
|
|
description: Please copy and paste any relevant log output. This will be
|
|
automatically formatted into code, so no need for backticks.
|
|
render: shell
|
|
validations:
|
|
required: false
|