From 69e2955a5af98ec7a8ce262b1bbc93c9ff3af1be Mon Sep 17 00:00:00 2001
From: GJS
Date: Tue, 1 Apr 2025 10:00:48 +0200
Subject: [PATCH] Improved: Enhance wording in the Pull Request template
- Refined the language in the PULL_REQUEST_TEMPLATE.md for better clarity and consistency.
- Updated the wording of the "Related Issues" and "Additional Context" sections for improved understanding.
- Made the instructions more concise and easier to follow.
modified: .github/PULL_REQUEST_TEMPLATE.md
---
.github/PULL_REQUEST_TEMPLATE.md | 18 ++++++++++++------
1 file changed, 12 insertions(+), 6 deletions(-)
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 5b1c77649..5c954e79f 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -17,7 +17,7 @@ We appreciate your patience and understanding as we continue to improve Uptime K
- **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.
-## 📋 Overview
+## 📋 Overview *
Provide a clear summary of the purpose and scope of this pull request:
@@ -35,7 +35,7 @@ Provide a clear summary of the purpose and scope of this pull request:
## 🔄 Changes
-### 🛠️ Type of change
+### 🛠️ Type of change *
Please select all options that apply:
@@ -51,13 +51,19 @@ Please select all options that apply:
## 🔗 Related Issues
-Reference any related GitHub issues or tasks that this pull request addresses. Use issue links, for example:
+Reference any related GitHub issues or tasks that this pull request addresses. Use proper issue links or numbers.
+
+Click here for related examples:
+
- Relates to #issue-number
- Resolves #issue-number
- Fixes #issue-number
-## 📄 Checklist
+
+
+
+## 📄 Checklist *
Please select all options that apply:
@@ -76,7 +82,7 @@ Please select all options that apply:
Please upload the image directly here by pasting it or dragging and dropping. Avoid using external image services as the image will be uploaded automatically.
-For more details: (click to expand)
+Click here for more details:
If this pull request introduces visual changes, please provide the following details:
@@ -98,7 +104,7 @@ If this pull request introduces visual changes, please provide the following det
Provide any additional information to help reviewers:
-For more details: (click to expand)
+Click here for more details:
- Design decisions or trade-offs made during development.