Updated: Modify "Ask for help" template with improved labels and descriptions

- Updated checkbox labels and descriptions to clarify instructions for verifying duplicate issues and agreeing to the security policy.
- Adjusted the wording in the "steps-to-reproduce" and "error-msg" sections for clarity.
- Enhanced deployment environment section to include more detailed instructions for setup.
- Improved overall formatting for readability and consistency.

modified: .github/ISSUE_TEMPLATE/ask_for_help.yml
This commit is contained in:
GJS 2025-03-31 13:35:19 +02:00
parent 6565d87bdc
commit da4ef1a37a
No known key found for this signature in database
GPG key ID: BE32D9EAF927E85B

View file

@ -1,10 +1,11 @@
--- ---
name: "❓ Ask for help" name: ❓ Ask for help
description: "Submit any question related to Uptime Kuma" description: |
#title: "[Help] " Submit any question related to Uptime Kuma
#title: "[Help]"
labels: ["help", "P3-low"] labels: ["help", "P3-low"]
body: body:
- type: "markdown" - type: markdown
attributes: attributes:
value: | value: |
## **❗ Important: Please Avoid Unnecessary Pinging of Maintainers** ## **❗ Important: Please Avoid Unnecessary Pinging of Maintainers**
@ -13,76 +14,90 @@ body:
- **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. - **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. - **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 - type: checkboxes
id: no-duplicate-issues id: no-duplicate-question
attributes: attributes:
label: "⚠️ Please verify that this question has NOT been raised before." label: ⚠️ Please verify that your question has not already been reported
description: "Search in the issues sections by clicking description: |
[HERE](https://github.com/louislam/uptime-kuma/issues?q=)" To avoid duplicate reports, please search for any existing issues before submitting a new one. You can find the list of existing issues **[HERE](https://github.com/louislam/uptime-kuma/issues?=is%3Aissue%20sort%3Acreated-desc%20)**.
options: options:
- label: "I checked and didn't find similar issue" - label: |
I have searched the [existing issues](https://github.com/louislam/uptime-kuma/issues?q=is%3Aissue%20sort%3Acreated-desc%20) and found no similar reports.
required: true required: true
- type: checkboxes - type: checkboxes
id: security-policy
attributes: attributes:
label: "🛡️ Security Policy" label: 🛡️ Security Policy
description: description: |
Please review the security policy before reporting security related Please review and acknowledge the Security Policy before reporting any security-related issues or bugs. You can find the full Security Policy **[HERE](https://github.com/louislam/uptime-kuma/security/policy)**.
issues/bugs.
options: options:
- label: I agree to have read this project [Security - label: |
Policy](https://github.com/louislam/uptime-kuma/security/policy) I have read and agree to Uptime Kuma's [Security Policy](https://github.com/louislam/uptime-kuma/security/policy).
required: true required: true
- type: textarea - type: textarea
id: steps-to-reproduce id: steps-to-reproduce
validations: validations:
required: true required: true
attributes: attributes:
label: "📝 Describe your problem" label: 📝 Describe your problem
description: description: |
"Please walk us through it step by step. Include all important details Please walk us through it step by step. Include all important details and add screenshots where appropriate
and add screenshots where appropriate" placeholder: |
placeholder: "Describe what are you asking for..." Describe what are you asking for ...
- type: textarea - type: textarea
id: error-msg id: error-msg
attributes:
label: 📝 Error Message(s) or Log
description: |
Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: bash session
validations: validations:
required: false required: false
attributes:
label: "📝 Error Message(s) or Log"
- type: input - type: input
id: uptime-kuma-version id: uptime-kuma-version
attributes: attributes:
label: "🐻 Uptime-Kuma Version" label: 🐻 Uptime-Kuma Version
description: "What version of Uptime-Kuma are you running? Please do not provide Docker tags like `latest` or `1`." description: |
placeholder: "e.g., 1.23.16 or 2.0.0-beta.2" 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: validations:
required: true required: true
- type: input - type: input
id: operating-system id: operating-system
attributes: attributes:
label: "💻 Operating System and Arch" label: 💻 Operating System and Arch
description: description: |
"Which OS is your server/device running on? (For Replit, please do not Which OS is your server/device running on? (For Replit, please do not report this bug)
report this bug)" placeholder: |
placeholder: "e.g., Ubuntu Server 24.04.2 LTS (GNU/Linux 6.8.0-55-generic x86_64)" e.g., Ubuntu Server 24.04.2 LTS (GNU/Linux 6.8.0-55-generic x86_64)
validations: validations:
required: true required: true
- type: input - type: input
id: browser-vendor id: browser-vendor
attributes: attributes:
label: "🌐 Browser" label: 🌐 Browser
description: description: |
"Which browser are you running on? (For Replit, please do not report Which browser are you running on? (For Replit, please do not report this bug)
this bug)" placeholder: |
placeholder: "e.g., Google Chrome 134.0.6998.183 (Official Build) (64-bit)" e.g., Google Chrome 134.0.6998.183 (Official Build) (64-bit)
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: deployment-info id: deployment-info
attributes: attributes:
label: "🖥️ Deployment Environment" label: 🖥️ Deployment Environment
description: | description: |
Provide details about the deployment environment, including runtime components, databases, and storage configurations. Provide details about the deployment environment, including runtime components, databases, and storage configurations. This will
This will help assess the infrastructure and identify any potential compatibility requirements. help assess the infrastructure and identify any potential compatibility requirements.
**Remove any fields that do not apply to your setup.** **Remove any fields that do not apply to your setup.**
value: | value: |