Updated: Improve clarity and fix minor linter issues in bug_report.yml

- 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
This commit is contained in:
GJS 2025-03-30 11:21:25 +02:00
parent 12f1084aab
commit a4f9e75f50
No known key found for this signature in database
GPG key ID: BE32D9EAF927E85B

View file

@ -19,8 +19,7 @@ body:
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: description: "Search related issues by clicking
"Search related issues by clicking
[HERE](https://github.com/louislam/uptime-kuma/issues?q=) and explain [HERE](https://github.com/louislam/uptime-kuma/issues?q=) and explain
what the difference between them or explain that you are unable to find what the difference between them or explain that you are unable to find
any related issues" any related issues"
@ -34,8 +33,7 @@ body:
Please review the security policy before reporting security related Please review the security policy before reporting security related
issues/bugs. issues/bugs.
options: options:
- label: - label: I agree to have read this project [Security
I agree to have read this project [Security
Policy](https://github.com/louislam/uptime-kuma/security/policy) Policy](https://github.com/louislam/uptime-kuma/security/policy)
required: true required: true
- type: textarea - type: textarea
@ -75,10 +73,8 @@ body:
id: uptime-kuma-version id: uptime-kuma-version
attributes: attributes:
label: "🐻 Uptime-Kuma Version" label: "🐻 Uptime-Kuma Version"
description: description: "What version of Uptime-Kuma are you running? Please do not provide Docker tags like `latest` or `1`."
"Which version of Uptime-Kuma are you running? Please do NOT provide the placeholder: "e.g., 1.23.16 or 2.0.0-beta.2"
docker tag such as latest or 1"
placeholder: "Ex. 1.10.0"
validations: validations:
required: true required: true
- type: input - type: input
@ -88,7 +84,7 @@ body:
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: "Ex. Ubuntu 20.04 x64 " 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
@ -96,7 +92,7 @@ body:
attributes: attributes:
label: "🌐 Browser" label: "🌐 Browser"
description: "Which browser are you running on?" description: "Which browser are you running on?"
placeholder: "Ex. Google Chrome 95.0.4638.69" placeholder: "e.g., Google Chrome 134.0.6998.183 (Official Build) (64-bit)"
validations: validations:
required: true required: true
- type: textarea - type: textarea
@ -104,24 +100,36 @@ body:
attributes: attributes:
label: "🖥️ Deployment Environment" label: "🖥️ Deployment Environment"
description: | description: |
examples: Provide details about the deployment environment, including runtime components, databases, and storage configurations.
- **Runtime**: Docker 20.10.9 / nodejs 18.17.1 / K8S via ... v1.3.3 / .. This will help assess the infrastructure and identify any potential compatibility requirements.
- **Database**: sqlite/embedded mariadb/external mariadb
- **Filesystem used to store the database on**: Windows/ZFS/btrfs/NFSv3 on a SSD/HDD/eMMC **Remove any fields that do not apply to your setup.**
- **number of monitors**: 42
value: | value: |
- Runtime: - **Runtime Environment**:
- Database: - Docker: Version `X.X.X` (Build `Y.Y.Y`)
- Filesystem used to store the database on: - Docker Compose: Version `X.X.X`
- number of monitors: - 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: validations:
required: true required: true
- type: textarea - type: textarea
id: logs id: logs
attributes: attributes:
label: "📝 Relevant log output" label: "📝 Relevant log output"
description: description: Please copy and paste any relevant log output. This will be
Please copy and paste any relevant log output. This will be
automatically formatted into code, so no need for backticks. automatically formatted into code, so no need for backticks.
render: shell render: shell
validations: validations: