Kuma/.github/ISSUE_TEMPLATE/ask_for_help.yml
GJS 12f1084aab
Updated: Improve clarity and fix minor linter issues in ask_for_help.yml
- Updated the descriptions and placeholders for better clarity and accuracy.
- Fixed minor formatting issues to align with current documentation standards.
- Added more detailed explanations in the deployment environment section for better user guidance.

modified: .github/ISSUE_TEMPLATE/ask_for_help.yml
2025-03-30 11:21:06 +02:00

108 lines
4.2 KiB
YAML

---
name: "❓ Ask for help"
description: "Submit any question related to Uptime Kuma"
#title: "[Help] "
labels: ["help", "P3-low"]
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: checkboxes
id: no-duplicate-issues
attributes:
label: "⚠️ Please verify that this question has NOT been raised before."
description: "Search in the issues sections by clicking
[HERE](https://github.com/louislam/uptime-kuma/issues?q=)"
options:
- label: "I checked and didn't find similar issue"
required: true
- 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: steps-to-reproduce
validations:
required: true
attributes:
label: "📝 Describe your problem"
description:
"Please walk us through it step by step. Include all important details
and add screenshots where appropriate"
placeholder: "Describe what are you asking for..."
- type: textarea
id: error-msg
validations:
required: false
attributes:
label: "📝 Error Message(s) or Log"
- 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? (For Replit, please do not report
this bug)"
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