mirror of
https://github.com/louislam/uptime-kuma.git
synced 2025-06-01 19:32:34 +02:00
Updated: Revise bug report template for clarity and organization
- Improved the description of how to find related issues and pull requests. - Added a direct link to the most recent issues and pull requests for better navigation. - Reworded the "Security Policy" section to emphasize review and acknowledgment before reporting bugs. - Adjusted the "Reproduction steps" and "Expected behavior" sections to ensure clear formatting. - Enhanced placeholder text and descriptions for better user experience when reporting bugs. modified: .github/ISSUE_TEMPLATE/bug_report.yml
This commit is contained in:
GJS
parent
c9c713f17b
commit
6565d87bdc
1 changed files with 70 additions and 49 deletions
119
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
119
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
|
|
@ -1,10 +1,11 @@
|
||||||
---
|
---
|
||||||
name: "🐛 Bug Report"
|
name: 🐛 Bug Report
|
||||||
description: "Submit a bug report to help us improve"
|
description: |
|
||||||
#title: "[Bug] "
|
Submit a bug report to help us improve
|
||||||
|
#title: "[Bug]"
|
||||||
labels: ["bug", "P2-medium"]
|
labels: ["bug", "P2-medium"]
|
||||||
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,95 +14,114 @@ 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: textarea
|
- type: textarea
|
||||||
id: related-issues
|
id: related-issues
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
attributes:
|
attributes:
|
||||||
label: "📑 I have found these related issues/pull requests"
|
label: 📑 I have found these related issues/pull requests
|
||||||
description: "Search related issues by clicking
|
description: |
|
||||||
[HERE](https://github.com/louislam/uptime-kuma/issues?q=) and explain
|
Please search for related **[ISSUES](https://github.com/louislam/uptime-kuma/issues?q=is%3Aissue%20sort%3Acreated-desc)**
|
||||||
what the difference between them or explain that you are unable to find
|
and **[PULL REQUESTS](https://github.com/louislam/uptime-kuma/pulls?q=is%3Apr+sort%3Acreated-desc+)**.
|
||||||
any related issues"
|
Explain the differences between them or clarify if you were unable to find any related issues/pull requests.
|
||||||
placeholder:
|
placeholder: |
|
||||||
"Related to #1 by also touching the ... system. They should not be
|
Example: This relates to issue #1, which also affects the ... system. It should not be merged because ...
|
||||||
merged because ..."
|
|
||||||
- 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: description
|
id: description
|
||||||
validations:
|
validations:
|
||||||
required: false
|
required: false
|
||||||
attributes:
|
attributes:
|
||||||
label: "Description"
|
label: Description
|
||||||
description: "You could also upload screenshots"
|
description: |
|
||||||
|
You could also upload screenshots
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: steps-to-reproduce
|
id: steps-to-reproduce
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
attributes:
|
attributes:
|
||||||
label: "👟 Reproduction steps"
|
label: 👟 Reproduction steps
|
||||||
description:
|
description: |
|
||||||
"How do you trigger this bug? Please walk us through it step by step.
|
How do you trigger this bug? Please walk us through it step by step. Include all important details and add screenshots where appropriate
|
||||||
Include all important details and add screenshots where appropriate"
|
placeholder: |
|
||||||
placeholder: "..."
|
...
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: expected-behavior
|
id: expected-behavior
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
attributes:
|
attributes:
|
||||||
label: "👀 Expected behavior"
|
label: 👀 Expected behavior
|
||||||
description: "What did you think would happen?"
|
description: |
|
||||||
placeholder: "..."
|
What did you think would happen?
|
||||||
|
placeholder: |
|
||||||
|
...
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: actual-behavior
|
id: actual-behavior
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
attributes:
|
attributes:
|
||||||
label: "😓 Actual Behavior"
|
label: 😓 Actual Behavior
|
||||||
description: "What actually happen?"
|
description: |
|
||||||
placeholder: "..."
|
What actually happen?
|
||||||
|
placeholder: |
|
||||||
|
...
|
||||||
|
|
||||||
- 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: "e.g., Ubuntu Server 24.04.2 LTS (GNU/Linux 6.8.0-55-generic x86_64)"
|
placeholder: |
|
||||||
|
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: "Which browser are you running on?"
|
description: |
|
||||||
placeholder: "e.g., Google Chrome 134.0.6998.183 (Official Build) (64-bit)"
|
Which browser are you running on?
|
||||||
|
placeholder: |
|
||||||
|
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: |
|
||||||
|
|
@ -125,12 +145,13 @@ body:
|
||||||
- Number of monitors: `X`
|
- Number of monitors: `X`
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: logs
|
id: logs
|
||||||
attributes:
|
attributes:
|
||||||
label: "📝 Relevant log output"
|
label: 📝 Relevant log output
|
||||||
description: Please copy and paste any relevant log output. This will be
|
description: |
|
||||||
automatically formatted into code, so no need for backticks.
|
Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
|
||||||
render: shell
|
render: bash session
|
||||||
validations:
|
validations:
|
||||||
required: false
|
required: false
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue