From 1969798343c276f0b4ec036af3cfd271af1dacd9 Mon Sep 17 00:00:00 2001 From: Pratik Chaudhary Date: Wed, 14 Oct 2026 12:01:33 +0200 Subject: [PATCH 1/2] Refine pull request template for clarity and detail Updated the pull request template to clarify sections on description, changes included, and testing instructions. --- .github/pull_request_template.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 6720e1b..a60c8c4 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,15 +1,15 @@ **Description:** -Add description here. It should illustrate the main purpose of the PR, including an overview of the problem and the technical solution. It should not repeat the task description, but rather go in depth regarding implementation choices. If the PR is really simple, this can be avoided, and the section deleted. +Explain why the change is needed, how it works in the implementation, and why this approach was chosen (when there was a real choice). Also mention anything the diff does not show: deliberate omissions, rollout or deploy order, feature flags, risks, or what was not verified. Length follows the content: a complex change can take several paragraphs, a simple one a sentence. Do not restate what the diff already shows (added tests, moved or renamed files, new components, refactors). -**This PR includes:** +**Additionally, this also includes:** -- Add main changes here +- Optional, delete if empty. Only side changes a reviewer would not expect from the description, e.g. an unrelated fix, or a summary of a generated diff that is hard to read (icons, API client, tokens) -**How to run:** +**How to test:** -- Add instructions on how to run here +- Steps to reproduce the issue and what happens now, or where to find the feature (preview link, page, flag, required plan or data) and what to expect. Do not list lint, type checks, or tests; CI runs them **Demo:** From 7af5007c1da774938cf9f928f9ba66408e7e3877 Mon Sep 17 00:00:00 2001 From: Pratik Chaudhary Date: Thu, 15 Oct 2026 12:54:32 +0200 Subject: [PATCH 2/2] Revise testing instructions in pull request template Updated the testing instructions for clarity on how to test changes. --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index a60c8c4..dc23f09 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -9,7 +9,7 @@ Explain why the change is needed, how it works in the implementation, and why th **How to test:** -- Steps to reproduce the issue and what happens now, or where to find the feature (preview link, page, flag, required plan or data) and what to expect. Do not list lint, type checks, or tests; CI runs them +- How a reviewer can check this change: how to run it, what to do, and what to expect. For a bug, how to reproduce it; for a feature, where to find it (preview link, page, flag, required plan or data) **Demo:**