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
2025-04-20 15:46:02 -04:00 · 2025-03-31 13:34:45 +02:00 · 2025-03-31 13:34:45 +02:00 · 6565d87bdc
commit 6565d87bdc
parent c9c713f17b
1 changed files with 70 additions and 49 deletions
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@ -1,10 +1,11 @@
 ---
-name: "🐛 Bug Report"
-description: "Submit a bug report to help us improve"
-#title: "[Bug] "
+name: 🐛 Bug Report
+description: |
+  Submit a bug report to help us improve
+#title: "[Bug]"
 labels: ["bug", "P2-medium"]
 body:
-  - type: "markdown"
+  - type: markdown
    attributes:
      value: |
        ## **❗ 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.
        - **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 ..."
+      label: 📑 I have found these related issues/pull requests
+      description: |
+        Please search for related **[ISSUES](https://github.com/louislam/uptime-kuma/issues?q=is%3Aissue%20sort%3Acreated-desc)**
+        and **[PULL REQUESTS](https://github.com/louislam/uptime-kuma/pulls?q=is%3Apr+sort%3Acreated-desc+)**.
+        Explain the differences between them or clarify if you were unable to find any related issues/pull requests.
+      placeholder: |
+        Example: This relates to issue #1, which also affects the ... system. It should not be merged because ...
+
  - type: checkboxes
+    id: security-policy
    attributes:
-      label: "🛡️ Security Policy"
-      description:
-        Please review the security policy before reporting security related
-        issues/bugs.
+      label: 🛡️ Security Policy
+      description: |
+        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)**.
      options:
-        - label: I agree to have read this project [Security
-            Policy](https://github.com/louislam/uptime-kuma/security/policy)
+        - label: |
+            I have read and agree to Uptime Kuma's [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"
+      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: "..."
+      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: "..."
+      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: "..."
+      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"
+      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)"
+      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)"
+      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"
+      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.
+        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: |
@ -125,12 +145,13 @@ body:
          - 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
+      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: bash session
    validations:
      required: false